Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Doppler
  3. API Docs
  4. Webhook
Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
pulumiverse/pulumi-doppler

doppler.Webhook

Explore with Pulumi AI

doppler logo
Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
pulumiverse/pulumi-doppler

    Create Webhook Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Webhook(name: string, args: WebhookArgs, opts?: CustomResourceOptions);
    @overload
def Webhook(resource_name: str,
            args: WebhookArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Webhook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            project: Optional[str] = None,
            url: Optional[str] = None,
            authentication: Optional[WebhookAuthenticationArgs] = None,
            enabled: Optional[bool] = None,
            enabled_configs: Optional[Sequence[str]] = None,
            payload: Optional[str] = None,
            secret: Optional[str] = None)
    func NewWebhook(ctx *Context, name string, args WebhookArgs, opts ...ResourceOption) (*Webhook, error)
    public Webhook(string name, WebhookArgs args, CustomResourceOptions? opts = null)
    public Webhook(String name, WebhookArgs args)
public Webhook(String name, WebhookArgs args, CustomResourceOptions options)

    type: doppler:Webhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var webhookResource = new Doppler.Webhook("webhookResource", new()
{
    Project = "string",
    Url = "string",
    Authentication = new Doppler.Inputs.WebhookAuthenticationArgs
    {
        Type = "string",
        Password = "string",
        Token = "string",
        Username = "string",
    },
    Enabled = false,
    EnabledConfigs = new[]
    {
        "string",
    },
    Payload = "string",
    Secret = "string",
});

    example, err := doppler.NewWebhook(ctx, "webhookResource", &doppler.WebhookArgs{
	Project: pulumi.String("string"),
	Url:     pulumi.String("string"),
	Authentication: &doppler.WebhookAuthenticationArgs{
		Type:     pulumi.String("string"),
		Password: pulumi.String("string"),
		Token:    pulumi.String("string"),
		Username: pulumi.String("string"),
	},
	Enabled: pulumi.Bool(false),
	EnabledConfigs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Payload: pulumi.String("string"),
	Secret:  pulumi.String("string"),
})

    var webhookResource = new Webhook("webhookResource", WebhookArgs.builder()
    .project("string")
    .url("string")
    .authentication(WebhookAuthenticationArgs.builder()
        .type("string")
        .password("string")
        .token("string")
        .username("string")
        .build())
    .enabled(false)
    .enabledConfigs("string")
    .payload("string")
    .secret("string")
    .build());

    webhook_resource = doppler.Webhook("webhookResource",
    project="string",
    url="string",
    authentication={
        "type": "string",
        "password": "string",
        "token": "string",
        "username": "string",
    },
    enabled=False,
    enabled_configs=["string"],
    payload="string",
    secret="string")

    const webhookResource = new doppler.Webhook("webhookResource", {
    project: "string",
    url: "string",
    authentication: {
        type: "string",
        password: "string",
        token: "string",
        username: "string",
    },
    enabled: false,
    enabledConfigs: ["string"],
    payload: "string",
    secret: "string",
});

    type: doppler:Webhook
properties:
    authentication:
        password: string
        token: string
        type: string
        username: string
    enabled: false
    enabledConfigs:
        - string
    payload: string
    project: string
    secret: string
    url: string

    Webhook Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Webhook resource accepts the following input properties:

    Project string
    The name of the Doppler project where the webhook is located
    Url string
    The URL of the webhook endpoint
    Authentication Pulumiverse.Doppler.Inputs.WebhookAuthentication
    Authentication method used by the webhook
    Enabled bool
    Whether the webhook is enabled or disabled. Default to true.
    EnabledConfigs List<string>
    Configs this webhook will trigger for
    Payload string
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    Secret string
    Secret used for request signing
    Project string
    The name of the Doppler project where the webhook is located
    Url string
    The URL of the webhook endpoint
    Authentication WebhookAuthenticationArgs
    Authentication method used by the webhook
    Enabled bool
    Whether the webhook is enabled or disabled. Default to true.
    EnabledConfigs []string
    Configs this webhook will trigger for
    Payload string
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    Secret string
    Secret used for request signing
    project String
    The name of the Doppler project where the webhook is located
    url String
    The URL of the webhook endpoint
    authentication WebhookAuthentication
    Authentication method used by the webhook
    enabled Boolean
    Whether the webhook is enabled or disabled. Default to true.
    enabledConfigs List<String>
    Configs this webhook will trigger for
    payload String
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    secret String
    Secret used for request signing
    project string
    The name of the Doppler project where the webhook is located
    url string
    The URL of the webhook endpoint
    authentication WebhookAuthentication
    Authentication method used by the webhook
    enabled boolean
    Whether the webhook is enabled or disabled. Default to true.
    enabledConfigs string[]
    Configs this webhook will trigger for
    payload string
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    secret string
    Secret used for request signing
    project str
    The name of the Doppler project where the webhook is located
    url str
    The URL of the webhook endpoint
    authentication WebhookAuthenticationArgs
    Authentication method used by the webhook
    enabled bool
    Whether the webhook is enabled or disabled. Default to true.
    enabled_configs Sequence[str]
    Configs this webhook will trigger for
    payload str
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    secret str
    Secret used for request signing
    project String
    The name of the Doppler project where the webhook is located
    url String
    The URL of the webhook endpoint
    authentication Property Map
    Authentication method used by the webhook
    enabled Boolean
    Whether the webhook is enabled or disabled. Default to true.
    enabledConfigs List<String>
    Configs this webhook will trigger for
    payload String
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    secret String
    Secret used for request signing

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Webhook resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Slug string
    The slug of the Webhook
    Id string
    The provider-assigned unique ID for this managed resource.
    Slug string
    The slug of the Webhook
    id String
    The provider-assigned unique ID for this managed resource.
    slug String
    The slug of the Webhook
    id string
    The provider-assigned unique ID for this managed resource.
    slug string
    The slug of the Webhook
    id str
    The provider-assigned unique ID for this managed resource.
    slug str
    The slug of the Webhook
    id String
    The provider-assigned unique ID for this managed resource.
    slug String
    The slug of the Webhook

    Look up Existing Webhook Resource

    Get an existing Webhook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WebhookState, opts?: CustomResourceOptions): Webhook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[WebhookAuthenticationArgs] = None,
        enabled: Optional[bool] = None,
        enabled_configs: Optional[Sequence[str]] = None,
        payload: Optional[str] = None,
        project: Optional[str] = None,
        secret: Optional[str] = None,
        slug: Optional[str] = None,
        url: Optional[str] = None) -> Webhook
    func GetWebhook(ctx *Context, name string, id IDInput, state *WebhookState, opts ...ResourceOption) (*Webhook, error)
    public static Webhook Get(string name, Input<string> id, WebhookState? state, CustomResourceOptions? opts = null)
    public static Webhook get(String name, Output<String> id, WebhookState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Authentication Pulumiverse.Doppler.Inputs.WebhookAuthentication
    Authentication method used by the webhook
    Enabled bool
    Whether the webhook is enabled or disabled. Default to true.
    EnabledConfigs List<string>
    Configs this webhook will trigger for
    Payload string
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    Project string
    The name of the Doppler project where the webhook is located
    Secret string
    Secret used for request signing
    Slug string
    The slug of the Webhook
    Url string
    The URL of the webhook endpoint
    Authentication WebhookAuthenticationArgs
    Authentication method used by the webhook
    Enabled bool
    Whether the webhook is enabled or disabled. Default to true.
    EnabledConfigs []string
    Configs this webhook will trigger for
    Payload string
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    Project string
    The name of the Doppler project where the webhook is located
    Secret string
    Secret used for request signing
    Slug string
    The slug of the Webhook
    Url string
    The URL of the webhook endpoint
    authentication WebhookAuthentication
    Authentication method used by the webhook
    enabled Boolean
    Whether the webhook is enabled or disabled. Default to true.
    enabledConfigs List<String>
    Configs this webhook will trigger for
    payload String
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    project String
    The name of the Doppler project where the webhook is located
    secret String
    Secret used for request signing
    slug String
    The slug of the Webhook
    url String
    The URL of the webhook endpoint
    authentication WebhookAuthentication
    Authentication method used by the webhook
    enabled boolean
    Whether the webhook is enabled or disabled. Default to true.
    enabledConfigs string[]
    Configs this webhook will trigger for
    payload string
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    project string
    The name of the Doppler project where the webhook is located
    secret string
    Secret used for request signing
    slug string
    The slug of the Webhook
    url string
    The URL of the webhook endpoint
    authentication WebhookAuthenticationArgs
    Authentication method used by the webhook
    enabled bool
    Whether the webhook is enabled or disabled. Default to true.
    enabled_configs Sequence[str]
    Configs this webhook will trigger for
    payload str
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    project str
    The name of the Doppler project where the webhook is located
    secret str
    Secret used for request signing
    slug str
    The slug of the Webhook
    url str
    The URL of the webhook endpoint
    authentication Property Map
    Authentication method used by the webhook
    enabled Boolean
    Whether the webhook is enabled or disabled. Default to true.
    enabledConfigs List<String>
    Configs this webhook will trigger for
    payload String
    The webhook's payload as a JSON string. Leave empty to use the default webhook payload
    project String
    The name of the Doppler project where the webhook is located
    secret String
    Secret used for request signing
    slug String
    The slug of the Webhook
    url String
    The URL of the webhook endpoint

    Supporting Types

    WebhookAuthentication, WebhookAuthenticationArgs

    Type string
    Password string
    Token string
    Username string
    Type string
    Password string
    Token string
    Username string
    type String
    password String
    token String
    username String
    type string
    password string
    token string
    username string
    type String
    password String
    token String
    username String

    Package Details

    Repository
    doppler pulumiverse/pulumi-doppler
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the doppler Terraform Provider.
    doppler logo
    Doppler v0.9.0 published on Tuesday, Aug 27, 2024 by Pulumiverse
    pulumiverse/pulumi-doppler