Organizations

Webhooks

UpdateOrganizationWebhook

Updates an existing organization-level webhook's configuration, including its destination URL, format, active status, event filter subscriptions, and shared secret. The 'pulumi_deployments' format can only be used on stack or environment webhooks, not organization-level ones.

patch/api/orgs/{orgName}/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/orgs/{orgName}/hooks/{hookName}
Auth: none declared

Path parameters

orgNamestring required

The organization name

hookNamestring required

The webhook name identifier

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