Stacks
Webhooks

CreateStackWebhook

Creates a new webhook for the specified stack. The request body must include the webhook name, payload URL, and format.

The format field accepts: raw (default), slack, ms_teams, or pulumi_deployments.

The filters field accepts a list of event types to subscribe to. See the webhook event filtering documentation for available filters.

The optional secret field sets the HMAC key for signature verification. See the webhook headers documentation for details.

Returns 409 if a webhook with the same name already exists. Returns 400 if the organization or stack name in the request body does not match the URL path parameters.

post/api/stacks/{orgName}/{projectName}/{stackName}/hooks

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/stacks/{orgName}/{projectName}/{stackName}/hooks
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

stackNamestring required

The stack name

Request body

activeboolean required

Whether the webhook is active and will receive deliveries.

displayNamestring required

The human-readable display name shown in the UI.

envNamestring

The environment name. Set when the webhook is scoped to a specific environment.

filtersstring[]

Specific event types this webhook subscribes to. If empty, all events are delivered.

formatstring

The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').

groupsstring[]

Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').

namestring

The unique identifier name for the webhook within its scope. Optional on creation; if omitted, the service generates a short random name. Always populated in responses.

organizationNamestring required

The organization that owns this webhook.

payloadUrlstring required

The URL to which webhook payloads are delivered.

projectNamestring

The project name. Set when the webhook is scoped to a specific stack.

secretstring

Secret will be omitted when returned from the service.

stackNamestring

The stack name. Set when the webhook is scoped to a specific stack.

Response

Created

activeboolean required

Whether the webhook is active and will receive deliveries.

displayNamestring required

The human-readable display name shown in the UI.

envNamestring

The environment name. Set when the webhook is scoped to a specific environment.

filtersstring[]

Specific event types this webhook subscribes to. If empty, all events are delivered.

formatstring

The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').

groupsstring[]

Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').

namestring

The unique identifier name for the webhook within its scope. Optional on creation; if omitted, the service generates a short random name. Always populated in responses.

organizationNamestring required

The organization that owns this webhook.

payloadUrlstring required

The URL to which webhook payloads are delivered.

projectNamestring

The project name. Set when the webhook is scoped to a specific stack.

secretstring

Secret will be omitted when returned from the service.

stackNamestring

The stack name. Set when the webhook is scoped to a specific stack.

hasSecretboolean required

HasSecret is true if the webhook has a secret. This is used to determine whether to show that there is a secret in the UI.

secretCiphertextstring required

SecretCiphertext is the ciphertext value of the webhook's secret. It's used to check whether the secret was changed by the PSP

Changes

No recorded changes to this operation across all 1 revision of this API.