Environments

CreateWebhook

Creates a new webhook for a Pulumi ESC environment. Webhooks allow external services to be notified when environment events occur, such as updates or opens. The request body specifies the webhook configuration including the destination URL, event filters, and format. Returns 400 if the organization name in the request body does not match the URL path parameter. Returns 409 if a webhook with the same name already exists.

post/api/preview/environments/{orgName}/{envName}/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/preview/environments/{orgName}/{envName}/hooks
Auth: none declared

Path parameters

orgNamestring required

The organization name

envNamestring required

The environment 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