pulumiservice.Webhook
Explore with Pulumi AI
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
new Webhook(name: string, args: WebhookArgs, opts?: CustomResourceOptions);
@overload
def Webhook(resource_name: str,
opts: Optional[ResourceOptions] = None,
active: Optional[bool] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[WebhookFilters]] = None,
format: Optional[WebhookFormat] = None,
organization_name: Optional[str] = None,
payload_url: Optional[str] = None,
project_name: Optional[str] = None,
secret: Optional[str] = None,
stack_name: Optional[str] = None)
@overload
def Webhook(resource_name: str,
args: WebhookArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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.
- Display
Name string The friendly name displayed in the Pulumi Service.
- Organization
Name string Name of the organization.
- Payload
Url string URL to send request to.
- Filters
List<Pulumi.
Pulumi Service. Webhook Filters> Optional set of filters to apply to the webhook. See webhook docs for more information.
- Format
Pulumi.
Pulumi Service. Webhook Format Format of the webhook payload. Can be either
raw
orslack
. Defaults toraw
.- Project
Name 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.
- Stack
Name 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 string The friendly name displayed in the Pulumi Service.
- Organization
Name string Name of the organization.
- Payload
Url string URL to send request to.
- Filters
[]Webhook
Filters Optional set of filters to apply to the webhook. See webhook docs for more information.
- Format
Webhook
Format Format of the webhook payload. Can be either
raw
orslack
. Defaults toraw
.- Project
Name 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.
- Stack
Name string Name of the stack. Only needed if this is a stack webhook.
- active Boolean
Indicates whether this webhook is enabled or not.
- display
Name String The friendly name displayed in the Pulumi Service.
- organization
Name String Name of the organization.
- payload
Url String URL to send request to.
- filters
List<Webhook
Filters> Optional set of filters to apply to the webhook. See webhook docs for more information.
- format
Webhook
Format Format of the webhook payload. Can be either
raw
orslack
. Defaults toraw
.- project
Name 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.
- stack
Name String Name of the stack. Only needed if this is a stack webhook.
- active boolean
Indicates whether this webhook is enabled or not.
- display
Name string The friendly name displayed in the Pulumi Service.
- organization
Name string Name of the organization.
- payload
Url string URL to send request to.
- filters
Webhook
Filters[] Optional set of filters to apply to the webhook. See webhook docs for more information.
- format
Webhook
Format Format of the webhook payload. Can be either
raw
orslack
. Defaults toraw
.- project
Name 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.
- stack
Name 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 Service.
- organization_
name str Name of the organization.
- payload_
url str URL to send request to.
- filters
Sequence[Webhook
Filters] Optional set of filters to apply to the webhook. See webhook docs for more information.
- format
Webhook
Format Format of the webhook payload. Can be either
raw
orslack
. Defaults toraw
.- 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.
- display
Name String The friendly name displayed in the Pulumi Service.
- organization
Name String Name of the organization.
- payload
Url 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"> Optional set of filters to apply to the webhook. See webhook docs for more information.
- format "raw" | "slack"
Format of the webhook payload. Can be either
raw
orslack
. Defaults toraw
.- project
Name 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.
- stack
Name 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:
Supporting Types
WebhookFilters
- Stack
Created - stack_created
Trigger a webhook when a stack is created. Only valid for org webhooks.
- Stack
Deleted - stack_deleted
Trigger a webhook when a stack is deleted. Only valid for org webhooks.
- Update
Succeeded - update_succeeded
Trigger a webhook when a stack update succeeds.
- Update
Failed - update_failed
Trigger a webhook when a stack update fails.
- Preview
Succeeded - preview_succeeded
Trigger a webhook when a stack preview succeeds.
- Preview
Failed - preview_failed
Trigger a webhook when a stack preview fails.
- Destroy
Succeeded - destroy_succeeded
Trigger a webhook when a stack destroy succeeds.
- Destroy
Failed - destroy_failed
Trigger a webhook when a stack destroy fails.
- Refresh
Succeeded - refresh_succeeded
Trigger a webhook when a stack refresh succeeds.
- Refresh
Failed - refresh_failed
Trigger a webhook when a stack refresh fails.
- Deployment
Queued - deployment_queued
Trigger a webhook when a deployment is queued.
- Deployment
Started - deployment_started
Trigger a webhook when a deployment starts running.
- Deployment
Succeeded - deployment_succeeded
Trigger a webhook when a deployment succeeds.
- Deployment
Failed - deployment_failed
Trigger a webhook when a deployment fails.
- Webhook
Filters Stack Created - stack_created
Trigger a webhook when a stack is created. Only valid for org webhooks.
- Webhook
Filters Stack Deleted - stack_deleted
Trigger a webhook when a stack is deleted. Only valid for org webhooks.
- Webhook
Filters Update Succeeded - update_succeeded
Trigger a webhook when a stack update succeeds.
- Webhook
Filters Update Failed - update_failed
Trigger a webhook when a stack update fails.
- Webhook
Filters Preview Succeeded - preview_succeeded
Trigger a webhook when a stack preview succeeds.
- Webhook
Filters Preview Failed - preview_failed
Trigger a webhook when a stack preview fails.
- Webhook
Filters Destroy Succeeded - destroy_succeeded
Trigger a webhook when a stack destroy succeeds.
- Webhook
Filters Destroy Failed - destroy_failed
Trigger a webhook when a stack destroy fails.
- Webhook
Filters Refresh Succeeded - refresh_succeeded
Trigger a webhook when a stack refresh succeeds.
- Webhook
Filters Refresh Failed - refresh_failed
Trigger a webhook when a stack refresh fails.
- Webhook
Filters Deployment Queued - deployment_queued
Trigger a webhook when a deployment is queued.
- Webhook
Filters Deployment Started - deployment_started
Trigger a webhook when a deployment starts running.
- Webhook
Filters Deployment Succeeded - deployment_succeeded
Trigger a webhook when a deployment succeeds.
- Webhook
Filters Deployment Failed - deployment_failed
Trigger a webhook when a deployment fails.
- Stack
Created - stack_created
Trigger a webhook when a stack is created. Only valid for org webhooks.
- Stack
Deleted - stack_deleted
Trigger a webhook when a stack is deleted. Only valid for org webhooks.
- Update
Succeeded - update_succeeded
Trigger a webhook when a stack update succeeds.
- Update
Failed - update_failed
Trigger a webhook when a stack update fails.
- Preview
Succeeded - preview_succeeded
Trigger a webhook when a stack preview succeeds.
- Preview
Failed - preview_failed
Trigger a webhook when a stack preview fails.
- Destroy
Succeeded - destroy_succeeded
Trigger a webhook when a stack destroy succeeds.
- Destroy
Failed - destroy_failed
Trigger a webhook when a stack destroy fails.
- Refresh
Succeeded - refresh_succeeded
Trigger a webhook when a stack refresh succeeds.
- Refresh
Failed - refresh_failed
Trigger a webhook when a stack refresh fails.
- Deployment
Queued - deployment_queued
Trigger a webhook when a deployment is queued.
- Deployment
Started - deployment_started
Trigger a webhook when a deployment starts running.
- Deployment
Succeeded - deployment_succeeded
Trigger a webhook when a deployment succeeds.
- Deployment
Failed - deployment_failed
Trigger a webhook when a deployment fails.
- Stack
Created - stack_created
Trigger a webhook when a stack is created. Only valid for org webhooks.
- Stack
Deleted - stack_deleted
Trigger a webhook when a stack is deleted. Only valid for org webhooks.
- Update
Succeeded - update_succeeded
Trigger a webhook when a stack update succeeds.
- Update
Failed - update_failed
Trigger a webhook when a stack update fails.
- Preview
Succeeded - preview_succeeded
Trigger a webhook when a stack preview succeeds.
- Preview
Failed - preview_failed
Trigger a webhook when a stack preview fails.
- Destroy
Succeeded - destroy_succeeded
Trigger a webhook when a stack destroy succeeds.
- Destroy
Failed - destroy_failed
Trigger a webhook when a stack destroy fails.
- Refresh
Succeeded - refresh_succeeded
Trigger a webhook when a stack refresh succeeds.
- Refresh
Failed - refresh_failed
Trigger a webhook when a stack refresh fails.
- Deployment
Queued - deployment_queued
Trigger a webhook when a deployment is queued.
- Deployment
Started - deployment_started
Trigger a webhook when a deployment starts running.
- Deployment
Succeeded - deployment_succeeded
Trigger a webhook when a deployment succeeds.
- Deployment
Failed - deployment_failed
Trigger a webhook when a deployment fails.
- STACK_CREATED
- stack_created
Trigger a webhook when a stack is created. Only valid for org webhooks.
- STACK_DELETED
- stack_deleted
Trigger a webhook when a stack is deleted. Only valid for org webhooks.
- UPDATE_SUCCEEDED
- update_succeeded
Trigger a webhook when a stack update succeeds.
- UPDATE_FAILED
- update_failed
Trigger a webhook when a stack update fails.
- PREVIEW_SUCCEEDED
- preview_succeeded
Trigger a webhook when a stack preview succeeds.
- PREVIEW_FAILED
- preview_failed
Trigger a webhook when a stack preview fails.
- DESTROY_SUCCEEDED
- destroy_succeeded
Trigger a webhook when a stack destroy succeeds.
- DESTROY_FAILED
- destroy_failed
Trigger a webhook when a stack destroy fails.
- REFRESH_SUCCEEDED
- refresh_succeeded
Trigger a webhook when a stack refresh succeeds.
- REFRESH_FAILED
- refresh_failed
Trigger a webhook when a stack refresh fails.
- DEPLOYMENT_QUEUED
- deployment_queued
Trigger a webhook when a deployment is queued.
- DEPLOYMENT_STARTED
- deployment_started
Trigger a webhook when a deployment starts running.
- DEPLOYMENT_SUCCEEDED
- deployment_succeeded
Trigger a webhook when a deployment succeeds.
- DEPLOYMENT_FAILED
- deployment_failed
Trigger a webhook when a deployment fails.
- "stack_
created" - stack_created
Trigger a webhook when a stack is created. Only valid for org webhooks.
- "stack_
deleted" - stack_deleted
Trigger a webhook when a stack is deleted. Only valid for org webhooks.
- "update_
succeeded" - update_succeeded
Trigger a webhook when a stack update succeeds.
- "update_
failed" - update_failed
Trigger a webhook when a stack update fails.
- "preview_
succeeded" - preview_succeeded
Trigger a webhook when a stack preview succeeds.
- "preview_
failed" - preview_failed
Trigger a webhook when a stack preview fails.
- "destroy_
succeeded" - destroy_succeeded
Trigger a webhook when a stack destroy succeeds.
- "destroy_
failed" - destroy_failed
Trigger a webhook when a stack destroy fails.
- "refresh_
succeeded" - refresh_succeeded
Trigger a webhook when a stack refresh succeeds.
- "refresh_
failed" - refresh_failed
Trigger a webhook when a stack refresh fails.
- "deployment_
queued" - deployment_queued
Trigger a webhook when a deployment is queued.
- "deployment_
started" - deployment_started
Trigger a webhook when a deployment starts running.
- "deployment_
succeeded" - deployment_succeeded
Trigger a webhook when a deployment succeeds.
- "deployment_
failed" - deployment_failed
Trigger a webhook when a deployment fails.
WebhookFormat
- Raw
- raw
The default webhook format.
- Slack
- slack
Messages formatted for consumption by Slack incoming webhooks.
- Webhook
Format Raw - raw
The default webhook format.
- Webhook
Format Slack - slack
Messages formatted for consumption by Slack incoming webhooks.
- Raw
- raw
The default webhook format.
- Slack
- slack
Messages formatted for consumption by Slack incoming webhooks.
- Raw
- raw
The default webhook format.
- Slack
- slack
Messages formatted for consumption by Slack incoming webhooks.
- RAW
- raw
The default webhook format.
- SLACK
- slack
Messages formatted for consumption by Slack incoming webhooks.
- "raw"
- raw
The default webhook format.
- "slack"
- slack
Messages formatted for consumption by Slack incoming webhooks.
Package Details
- Repository
- pulumiservice pulumi/pulumi-pulumiservice
- License
- Apache-2.0