Environments

UpdateWebhook

Updates the configuration of an existing webhook on a Pulumi ESC environment. The webhook is identified by its name in the URL path. The request body contains the updated webhook configuration including destination URL, event filters, format, and active status. Returns the updated WebhookResponse on success. Returns 400 if an invalid format is specified.

patch/api/esc/environments/{orgName}/{projectName}/{envName}/hooks/{hookName}

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/esc/environments/{orgName}/{projectName}/{envName}/hooks/{hookName}
Auth: none declared

Path parameters

orgNamestring required

The organization name

projectNamestring required

The project name

envNamestring required

The environment name

hookNamestring required

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