1. Packages
  2. Pulumi Cloud (Pulumi Service provider)
  3. API Docs
  4. Webhook
Pulumi Cloud v0.22.2 published on Friday, Jul 19, 2024 by Pulumi

pulumiservice.Webhook

Explore with Pulumi AI

pulumiservice logo
Pulumi Cloud v0.22.2 published on Friday, Jul 19, 2024 by Pulumi

    Pulumi Webhooks allow you to notify external services of events happening within your Pulumi organization or stack. For example, you can trigger a notification whenever a stack is updated. Whenever an event occurs, Pulumi will send an HTTP POST request to all registered webhooks. The webhook can then be used to emit some notification, start running integration tests, or even update additional stacks.

    Import

    Pulumi webhooks can be imported using the id, which for webhooks is {org}/{project}/{stack}/{webhook-name} e.g.,

     $ pulumi import pulumiservice:index:Webhook my_webhook my-org/my-project/my-stack/4b0d0671
    

    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,
                active: Optional[bool] = None,
                display_name: Optional[str] = None,
                organization_name: Optional[str] = None,
                payload_url: Optional[str] = None,
                filters: Optional[Sequence[WebhookFilters]] = None,
                format: Optional[WebhookFormat] = None,
                project_name: Optional[str] = None,
                secret: Optional[str] = None,
                stack_name: 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: pulumiservice: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 PulumiService.Webhook("webhookResource", new()
    {
        Active = false,
        DisplayName = "string",
        OrganizationName = "string",
        PayloadUrl = "string",
        Filters = new[]
        {
            PulumiService.WebhookFilters.StackCreated,
        },
        Format = PulumiService.WebhookFormat.Raw,
        ProjectName = "string",
        Secret = "string",
        StackName = "string",
    });
    
    example, err := pulumiservice.NewWebhook(ctx, "webhookResource", &pulumiservice.WebhookArgs{
    	Active:           pulumi.Bool(false),
    	DisplayName:      pulumi.String("string"),
    	OrganizationName: pulumi.String("string"),
    	PayloadUrl:       pulumi.String("string"),
    	Filters: pulumiservice.WebhookFiltersArray{
    		pulumiservice.WebhookFiltersStackCreated,
    	},
    	Format:      pulumiservice.WebhookFormatRaw,
    	ProjectName: pulumi.String("string"),
    	Secret:      pulumi.String("string"),
    	StackName:   pulumi.String("string"),
    })
    
    var webhookResource = new Webhook("webhookResource", WebhookArgs.builder()
        .active(false)
        .displayName("string")
        .organizationName("string")
        .payloadUrl("string")
        .filters("stack_created")
        .format("raw")
        .projectName("string")
        .secret("string")
        .stackName("string")
        .build());
    
    webhook_resource = pulumiservice.Webhook("webhookResource",
        active=False,
        display_name="string",
        organization_name="string",
        payload_url="string",
        filters=[pulumiservice.WebhookFilters.STACK_CREATED],
        format=pulumiservice.WebhookFormat.RAW,
        project_name="string",
        secret="string",
        stack_name="string")
    
    const webhookResource = new pulumiservice.Webhook("webhookResource", {
        active: false,
        displayName: "string",
        organizationName: "string",
        payloadUrl: "string",
        filters: [pulumiservice.WebhookFilters.StackCreated],
        format: pulumiservice.WebhookFormat.Raw,
        projectName: "string",
        secret: "string",
        stackName: "string",
    });
    
    type: pulumiservice:Webhook
    properties:
        active: false
        displayName: string
        filters:
            - stack_created
        format: raw
        organizationName: string
        payloadUrl: string
        projectName: string
        secret: string
        stackName: 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

    The Webhook resource accepts the following input properties:

    Active bool
    Indicates whether this webhook is enabled or not.
    DisplayName string
    The friendly name displayed in the Pulumi Cloud.
    OrganizationName string
    Name of the organization.
    PayloadUrl string
    URL to send request to.
    Filters List<Pulumi.PulumiService.WebhookFilters>
    Optional set of filters to apply to the webhook. See webhook docs for more information.
    Format Pulumi.PulumiService.WebhookFormat
    Format of the webhook payload. Can be either raw or slack. Defaults to raw.
    ProjectName string
    Name of the project. Only needed if this is a stack webhook.
    Secret string
    Optional. secret used as the HMAC key. See webhook docs for more information.
    StackName string
    Name of the stack. Only needed if this is a stack webhook.
    Active bool
    Indicates whether this webhook is enabled or not.
    DisplayName string
    The friendly name displayed in the Pulumi Cloud.
    OrganizationName string
    Name of the organization.
    PayloadUrl string
    URL to send request to.
    Filters []WebhookFilters
    Optional set of filters to apply to the webhook. See webhook docs for more information.
    Format WebhookFormat
    Format of the webhook payload. Can be either raw or slack. Defaults to raw.
    ProjectName string
    Name of the project. Only needed if this is a stack webhook.
    Secret string
    Optional. secret used as the HMAC key. See webhook docs for more information.
    StackName string
    Name of the stack. Only needed if this is a stack webhook.
    active Boolean
    Indicates whether this webhook is enabled or not.
    displayName String
    The friendly name displayed in the Pulumi Cloud.
    organizationName String
    Name of the organization.
    payloadUrl String
    URL to send request to.
    filters List<WebhookFilters>
    Optional set of filters to apply to the webhook. See webhook docs for more information.
    format WebhookFormat
    Format of the webhook payload. Can be either raw or slack. Defaults to raw.
    projectName String
    Name of the project. Only needed if this is a stack webhook.
    secret String
    Optional. secret used as the HMAC key. See webhook docs for more information.
    stackName String
    Name of the stack. Only needed if this is a stack webhook.
    active boolean
    Indicates whether this webhook is enabled or not.
    displayName string
    The friendly name displayed in the Pulumi Cloud.
    organizationName string
    Name of the organization.
    payloadUrl string
    URL to send request to.
    filters WebhookFilters[]
    Optional set of filters to apply to the webhook. See webhook docs for more information.
    format WebhookFormat
    Format of the webhook payload. Can be either raw or slack. Defaults to raw.
    projectName string
    Name of the project. Only needed if this is a stack webhook.
    secret string
    Optional. secret used as the HMAC key. See webhook docs for more information.
    stackName string
    Name of the stack. Only needed if this is a stack webhook.
    active bool
    Indicates whether this webhook is enabled or not.
    display_name str
    The friendly name displayed in the Pulumi Cloud.
    organization_name str
    Name of the organization.
    payload_url str
    URL to send request to.
    filters Sequence[WebhookFilters]
    Optional set of filters to apply to the webhook. See webhook docs for more information.
    format WebhookFormat
    Format of the webhook payload. Can be either raw or slack. Defaults to raw.
    project_name str
    Name of the project. Only needed if this is a stack webhook.
    secret str
    Optional. secret used as the HMAC key. See webhook docs for more information.
    stack_name str
    Name of the stack. Only needed if this is a stack webhook.
    active Boolean
    Indicates whether this webhook is enabled or not.
    displayName String
    The friendly name displayed in the Pulumi Cloud.
    organizationName String
    Name of the organization.
    payloadUrl String
    URL to send request to.
    filters List<"stack_created" | "stack_deleted" | "update_succeeded" | "update_failed" | "preview_succeeded" | "preview_failed" | "destroy_succeeded" | "destroy_failed" | "refresh_succeeded" | "refresh_failed" | "deployment_queued" | "deployment_started" | "deployment_succeeded" | "deployment_failed" | "drift_detected" | "drift_detection_succeeded" | "drift_detection_failed" | "drift_remediation_succeeded" | "drift_remediation_failed">
    Optional set of filters to apply to the webhook. See webhook docs for more information.
    format "raw" | "slack" | "pulumi_deployments" | "ms_teams"
    Format of the webhook payload. Can be either raw or slack. Defaults to raw.
    projectName String
    Name of the project. Only needed if this is a stack webhook.
    secret String
    Optional. secret used as the HMAC key. See webhook docs for more information.
    stackName String
    Name of the stack. Only needed if this is a stack webhook.

    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.
    Name string
    Webhook identifier generated by Pulumi Cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Webhook identifier generated by Pulumi Cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Webhook identifier generated by Pulumi Cloud.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Webhook identifier generated by Pulumi Cloud.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Webhook identifier generated by Pulumi Cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Webhook identifier generated by Pulumi Cloud.

    Supporting Types

    WebhookFilters, WebhookFiltersArgs

    StackCreated
    stack_createdTrigger a webhook when a stack is created. Only valid for org webhooks.
    StackDeleted
    stack_deletedTrigger a webhook when a stack is deleted. Only valid for org webhooks.
    UpdateSucceeded
    update_succeededTrigger a webhook when a stack update succeeds.
    UpdateFailed
    update_failedTrigger a webhook when a stack update fails.
    PreviewSucceeded
    preview_succeededTrigger a webhook when a stack preview succeeds.
    PreviewFailed
    preview_failedTrigger a webhook when a stack preview fails.
    DestroySucceeded
    destroy_succeededTrigger a webhook when a stack destroy succeeds.
    DestroyFailed
    destroy_failedTrigger a webhook when a stack destroy fails.
    RefreshSucceeded
    refresh_succeededTrigger a webhook when a stack refresh succeeds.
    RefreshFailed
    refresh_failedTrigger a webhook when a stack refresh fails.
    DeploymentQueued
    deployment_queuedTrigger a webhook when a deployment is queued.
    DeploymentStarted
    deployment_startedTrigger a webhook when a deployment starts running.
    DeploymentSucceeded
    deployment_succeededTrigger a webhook when a deployment succeeds.
    DeploymentFailed
    deployment_failedTrigger a webhook when a deployment fails.
    DriftDetected
    drift_detectedTrigger a webhook when drift is detected.
    DriftDetectionSucceeded
    drift_detection_succeededTrigger a webhook when a drift detection run succeeds, regardless of whether drift is detected.
    DriftDetectionFailed
    drift_detection_failedTrigger a webhook when a drift detection run fails.
    DriftRemediationSucceeded
    drift_remediation_succeededTrigger a webhook when a drift remediation run succeeds.
    DriftRemediationFailed
    drift_remediation_failedTrigger a webhook when a drift remediation run fails.
    WebhookFiltersStackCreated
    stack_createdTrigger a webhook when a stack is created. Only valid for org webhooks.
    WebhookFiltersStackDeleted
    stack_deletedTrigger a webhook when a stack is deleted. Only valid for org webhooks.
    WebhookFiltersUpdateSucceeded
    update_succeededTrigger a webhook when a stack update succeeds.
    WebhookFiltersUpdateFailed
    update_failedTrigger a webhook when a stack update fails.
    WebhookFiltersPreviewSucceeded
    preview_succeededTrigger a webhook when a stack preview succeeds.
    WebhookFiltersPreviewFailed
    preview_failedTrigger a webhook when a stack preview fails.
    WebhookFiltersDestroySucceeded
    destroy_succeededTrigger a webhook when a stack destroy succeeds.
    WebhookFiltersDestroyFailed
    destroy_failedTrigger a webhook when a stack destroy fails.
    WebhookFiltersRefreshSucceeded
    refresh_succeededTrigger a webhook when a stack refresh succeeds.
    WebhookFiltersRefreshFailed
    refresh_failedTrigger a webhook when a stack refresh fails.
    WebhookFiltersDeploymentQueued
    deployment_queuedTrigger a webhook when a deployment is queued.
    WebhookFiltersDeploymentStarted
    deployment_startedTrigger a webhook when a deployment starts running.
    WebhookFiltersDeploymentSucceeded
    deployment_succeededTrigger a webhook when a deployment succeeds.
    WebhookFiltersDeploymentFailed
    deployment_failedTrigger a webhook when a deployment fails.
    WebhookFiltersDriftDetected
    drift_detectedTrigger a webhook when drift is detected.
    WebhookFiltersDriftDetectionSucceeded
    drift_detection_succeededTrigger a webhook when a drift detection run succeeds, regardless of whether drift is detected.
    WebhookFiltersDriftDetectionFailed
    drift_detection_failedTrigger a webhook when a drift detection run fails.
    WebhookFiltersDriftRemediationSucceeded
    drift_remediation_succeededTrigger a webhook when a drift remediation run succeeds.
    WebhookFiltersDriftRemediationFailed
    drift_remediation_failedTrigger a webhook when a drift remediation run fails.
    StackCreated
    stack_createdTrigger a webhook when a stack is created. Only valid for org webhooks.
    StackDeleted
    stack_deletedTrigger a webhook when a stack is deleted. Only valid for org webhooks.
    UpdateSucceeded
    update_succeededTrigger a webhook when a stack update succeeds.
    UpdateFailed
    update_failedTrigger a webhook when a stack update fails.
    PreviewSucceeded
    preview_succeededTrigger a webhook when a stack preview succeeds.
    PreviewFailed
    preview_failedTrigger a webhook when a stack preview fails.
    DestroySucceeded
    destroy_succeededTrigger a webhook when a stack destroy succeeds.
    DestroyFailed
    destroy_failedTrigger a webhook when a stack destroy fails.
    RefreshSucceeded
    refresh_succeededTrigger a webhook when a stack refresh succeeds.
    RefreshFailed
    refresh_failedTrigger a webhook when a stack refresh fails.
    DeploymentQueued
    deployment_queuedTrigger a webhook when a deployment is queued.
    DeploymentStarted
    deployment_startedTrigger a webhook when a deployment starts running.
    DeploymentSucceeded
    deployment_succeededTrigger a webhook when a deployment succeeds.
    DeploymentFailed
    deployment_failedTrigger a webhook when a deployment fails.
    DriftDetected
    drift_detectedTrigger a webhook when drift is detected.
    DriftDetectionSucceeded
    drift_detection_succeededTrigger a webhook when a drift detection run succeeds, regardless of whether drift is detected.
    DriftDetectionFailed
    drift_detection_failedTrigger a webhook when a drift detection run fails.
    DriftRemediationSucceeded
    drift_remediation_succeededTrigger a webhook when a drift remediation run succeeds.
    DriftRemediationFailed
    drift_remediation_failedTrigger a webhook when a drift remediation run fails.
    StackCreated
    stack_createdTrigger a webhook when a stack is created. Only valid for org webhooks.
    StackDeleted
    stack_deletedTrigger a webhook when a stack is deleted. Only valid for org webhooks.
    UpdateSucceeded
    update_succeededTrigger a webhook when a stack update succeeds.
    UpdateFailed
    update_failedTrigger a webhook when a stack update fails.
    PreviewSucceeded
    preview_succeededTrigger a webhook when a stack preview succeeds.
    PreviewFailed
    preview_failedTrigger a webhook when a stack preview fails.
    DestroySucceeded
    destroy_succeededTrigger a webhook when a stack destroy succeeds.
    DestroyFailed
    destroy_failedTrigger a webhook when a stack destroy fails.
    RefreshSucceeded
    refresh_succeededTrigger a webhook when a stack refresh succeeds.
    RefreshFailed
    refresh_failedTrigger a webhook when a stack refresh fails.
    DeploymentQueued
    deployment_queuedTrigger a webhook when a deployment is queued.
    DeploymentStarted
    deployment_startedTrigger a webhook when a deployment starts running.
    DeploymentSucceeded
    deployment_succeededTrigger a webhook when a deployment succeeds.
    DeploymentFailed
    deployment_failedTrigger a webhook when a deployment fails.
    DriftDetected
    drift_detectedTrigger a webhook when drift is detected.
    DriftDetectionSucceeded
    drift_detection_succeededTrigger a webhook when a drift detection run succeeds, regardless of whether drift is detected.
    DriftDetectionFailed
    drift_detection_failedTrigger a webhook when a drift detection run fails.
    DriftRemediationSucceeded
    drift_remediation_succeededTrigger a webhook when a drift remediation run succeeds.
    DriftRemediationFailed
    drift_remediation_failedTrigger a webhook when a drift remediation run fails.
    STACK_CREATED
    stack_createdTrigger a webhook when a stack is created. Only valid for org webhooks.
    STACK_DELETED
    stack_deletedTrigger a webhook when a stack is deleted. Only valid for org webhooks.
    UPDATE_SUCCEEDED
    update_succeededTrigger a webhook when a stack update succeeds.
    UPDATE_FAILED
    update_failedTrigger a webhook when a stack update fails.
    PREVIEW_SUCCEEDED
    preview_succeededTrigger a webhook when a stack preview succeeds.
    PREVIEW_FAILED
    preview_failedTrigger a webhook when a stack preview fails.
    DESTROY_SUCCEEDED
    destroy_succeededTrigger a webhook when a stack destroy succeeds.
    DESTROY_FAILED
    destroy_failedTrigger a webhook when a stack destroy fails.
    REFRESH_SUCCEEDED
    refresh_succeededTrigger a webhook when a stack refresh succeeds.
    REFRESH_FAILED
    refresh_failedTrigger a webhook when a stack refresh fails.
    DEPLOYMENT_QUEUED
    deployment_queuedTrigger a webhook when a deployment is queued.
    DEPLOYMENT_STARTED
    deployment_startedTrigger a webhook when a deployment starts running.
    DEPLOYMENT_SUCCEEDED
    deployment_succeededTrigger a webhook when a deployment succeeds.
    DEPLOYMENT_FAILED
    deployment_failedTrigger a webhook when a deployment fails.
    DRIFT_DETECTED
    drift_detectedTrigger a webhook when drift is detected.
    DRIFT_DETECTION_SUCCEEDED
    drift_detection_succeededTrigger a webhook when a drift detection run succeeds, regardless of whether drift is detected.
    DRIFT_DETECTION_FAILED
    drift_detection_failedTrigger a webhook when a drift detection run fails.
    DRIFT_REMEDIATION_SUCCEEDED
    drift_remediation_succeededTrigger a webhook when a drift remediation run succeeds.
    DRIFT_REMEDIATION_FAILED
    drift_remediation_failedTrigger a webhook when a drift remediation run fails.
    "stack_created"
    stack_createdTrigger a webhook when a stack is created. Only valid for org webhooks.
    "stack_deleted"
    stack_deletedTrigger a webhook when a stack is deleted. Only valid for org webhooks.
    "update_succeeded"
    update_succeededTrigger a webhook when a stack update succeeds.
    "update_failed"
    update_failedTrigger a webhook when a stack update fails.
    "preview_succeeded"
    preview_succeededTrigger a webhook when a stack preview succeeds.
    "preview_failed"
    preview_failedTrigger a webhook when a stack preview fails.
    "destroy_succeeded"
    destroy_succeededTrigger a webhook when a stack destroy succeeds.
    "destroy_failed"
    destroy_failedTrigger a webhook when a stack destroy fails.
    "refresh_succeeded"
    refresh_succeededTrigger a webhook when a stack refresh succeeds.
    "refresh_failed"
    refresh_failedTrigger a webhook when a stack refresh fails.
    "deployment_queued"
    deployment_queuedTrigger a webhook when a deployment is queued.
    "deployment_started"
    deployment_startedTrigger a webhook when a deployment starts running.
    "deployment_succeeded"
    deployment_succeededTrigger a webhook when a deployment succeeds.
    "deployment_failed"
    deployment_failedTrigger a webhook when a deployment fails.
    "drift_detected"
    drift_detectedTrigger a webhook when drift is detected.
    "drift_detection_succeeded"
    drift_detection_succeededTrigger a webhook when a drift detection run succeeds, regardless of whether drift is detected.
    "drift_detection_failed"
    drift_detection_failedTrigger a webhook when a drift detection run fails.
    "drift_remediation_succeeded"
    drift_remediation_succeededTrigger a webhook when a drift remediation run succeeds.
    "drift_remediation_failed"
    drift_remediation_failedTrigger a webhook when a drift remediation run fails.

    WebhookFormat, WebhookFormatArgs

    Raw
    rawThe default webhook format.
    Slack
    slackMessages formatted for consumption by Slack incoming webhooks.
    PulumiDeployments
    pulumi_deploymentsInitiate deployments on a stack from a Pulumi Cloud webhook.
    MicrosoftTeams
    ms_teamsMessages formatted for consumption by Microsoft Teams incoming webhooks.
    WebhookFormatRaw
    rawThe default webhook format.
    WebhookFormatSlack
    slackMessages formatted for consumption by Slack incoming webhooks.
    WebhookFormatPulumiDeployments
    pulumi_deploymentsInitiate deployments on a stack from a Pulumi Cloud webhook.
    WebhookFormatMicrosoftTeams
    ms_teamsMessages formatted for consumption by Microsoft Teams incoming webhooks.
    Raw
    rawThe default webhook format.
    Slack
    slackMessages formatted for consumption by Slack incoming webhooks.
    PulumiDeployments
    pulumi_deploymentsInitiate deployments on a stack from a Pulumi Cloud webhook.
    MicrosoftTeams
    ms_teamsMessages formatted for consumption by Microsoft Teams incoming webhooks.
    Raw
    rawThe default webhook format.
    Slack
    slackMessages formatted for consumption by Slack incoming webhooks.
    PulumiDeployments
    pulumi_deploymentsInitiate deployments on a stack from a Pulumi Cloud webhook.
    MicrosoftTeams
    ms_teamsMessages formatted for consumption by Microsoft Teams incoming webhooks.
    RAW
    rawThe default webhook format.
    SLACK
    slackMessages formatted for consumption by Slack incoming webhooks.
    PULUMI_DEPLOYMENTS
    pulumi_deploymentsInitiate deployments on a stack from a Pulumi Cloud webhook.
    MICROSOFT_TEAMS
    ms_teamsMessages formatted for consumption by Microsoft Teams incoming webhooks.
    "raw"
    rawThe default webhook format.
    "slack"
    slackMessages formatted for consumption by Slack incoming webhooks.
    "pulumi_deployments"
    pulumi_deploymentsInitiate deployments on a stack from a Pulumi Cloud webhook.
    "ms_teams"
    ms_teamsMessages formatted for consumption by Microsoft Teams incoming webhooks.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo
    Pulumi Cloud v0.22.2 published on Friday, Jul 19, 2024 by Pulumi