Webhooks

Returns all webhooks configured at the organization level. Each webhook in the response includes its name, destination URL, format (generic JSON, Slack, or Microsoft Teams), active status, and subscribed event filters. Organization-level webhooks can fire on stack lifecycle events, deployment events, drift detection events, and policy violation events.

Request Parameters

• orgName string path required
  The organization name

Responses

Creates a new webhook for an organization to notify external services when events occur. Webhooks can be configured to fire on stack events (created, deleted, update succeeded/failed), deployment events (queued, started, succeeded, failed), drift detection events, and policy violation events (mandatory, advisory).

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 via the Pulumi-Webhook-Signature header. See the webhook headers documentation for details.

Request Parameters

• orgName string path required
  The organization name

Request Body

• organizationName string required
  The organization that owns this webhook.
• projectName string optional
  The project name. Set when the webhook is scoped to a specific stack.
• stackName string optional
  The stack name. Set when the webhook is scoped to a specific stack.
• envName string optional
  The environment name. Set when the webhook is scoped to a specific environment.
• name string required
  The unique identifier name for the webhook within its scope.
• displayName string required
  The human-readable display name shown in the UI.
• payloadUrl string required
  The URL to which webhook payloads are delivered.
• secret string optional
  Secret will be omitted when returned from the service.
• active boolean required
  Whether the webhook is active and will receive deliveries.
• format string optional
  The format of the webhook payload (e.g., ‘raw’, ‘slack’, ‘ms_teams’).
• filters array[string] optional
  Specific event types this webhook subscribes to. If empty, all events are delivered.
• groups array[string] optional
  Event groups this webhook subscribes to (e.g., ‘stacks’, ‘deployments’).

Responses

Returns the configuration of a specific organization-level webhook, including its name, destination URL, format (generic JSON, Slack, or Microsoft Teams), active status, event filter subscriptions, and whether a shared secret is configured for HMAC signature verification.

Request Parameters

• orgName string path required
  The organization name
• hookName string path required
  The webhook name identifier

Responses

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.

Request Parameters

• orgName string path required
  The organization name
• hookName string path required
  The webhook name identifier

Request Body

• organizationName string required
  The organization that owns this webhook.
• projectName string optional
  The project name. Set when the webhook is scoped to a specific stack.
• stackName string optional
  The stack name. Set when the webhook is scoped to a specific stack.
• envName string optional
  The environment name. Set when the webhook is scoped to a specific environment.
• name string required
  The unique identifier name for the webhook within its scope.
• displayName string required
  The human-readable display name shown in the UI.
• payloadUrl string required
  The URL to which webhook payloads are delivered.
• secret string optional
  Secret will be omitted when returned from the service.
• active boolean required
  Whether the webhook is active and will receive deliveries.
• format string optional
  The format of the webhook payload (e.g., ‘raw’, ‘slack’, ‘ms_teams’).
• filters array[string] optional
  Specific event types this webhook subscribes to. If empty, all events are delivered.
• groups array[string] optional
  Event groups this webhook subscribes to (e.g., ‘stacks’, ‘deployments’).

Responses

Permanently deletes an organization-level webhook. The webhook will no longer receive event notifications for stack updates, deployments, drift detection, or policy violations. This action cannot be undone.

Request Parameters

• orgName string path required
  The organization name
• hookName string path required
  The webhook name identifier

Responses

Returns the recent delivery history for a specific webhook, including the HTTP status code, response time, request payload, and delivery timestamp for each attempt. This allows monitoring webhook health and diagnosing delivery failures. Each delivery includes a unique Pulumi-Webhook-ID.

Request Parameters

• orgName string path required
  The organization name
• hookName string path required
  The webhook name identifier

Responses

Triggers the Pulumi Service to redeliver a specific event to a webhook. For example, to resend an event that the hook failed to process the first time.

Request Parameters

• orgName string path required
  The organization name
• hookName string path required
  The webhook name identifier
• event string path required
  The event identifier to redeliver

Responses

Sends a test ping to an organization webhook to validate that it is working. This function bypasses the message queue machinery and issues the request directly to the webhook.

Request Parameters

• orgName string path required
  The organization name
• hookName string path required
  The webhook name identifier

Responses

Returns all webhooks configured for the specified stack. Each webhook in the response includes its name, display name, payload URL, format, filters, and active status.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name

Responses

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.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name

Request Body

• organizationName string required
  The organization that owns this webhook.
• projectName string optional
  The project name. Set when the webhook is scoped to a specific stack.
• stackName string optional
  The stack name. Set when the webhook is scoped to a specific stack.
• envName string optional
  The environment name. Set when the webhook is scoped to a specific environment.
• name string required
  The unique identifier name for the webhook within its scope.
• displayName string required
  The human-readable display name shown in the UI.
• payloadUrl string required
  The URL to which webhook payloads are delivered.
• secret string optional
  Secret will be omitted when returned from the service.
• active boolean required
  Whether the webhook is active and will receive deliveries.
• format string optional
  The format of the webhook payload (e.g., ‘raw’, ‘slack’, ‘ms_teams’).
• filters array[string] optional
  Specific event types this webhook subscribes to. If empty, all events are delivered.
• groups array[string] optional
  Event groups this webhook subscribes to (e.g., ‘stacks’, ‘deployments’).

Responses

Returns the details of a single webhook identified by its name, including its configuration, filters, groups, and active status. Returns 404 if the webhook does not exist.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• hookName string path required
  The webhook name

Responses

Updates an existing webhook’s configuration. Supports modifying the display name, payload URL, format, groups, filters, and active status. The ‘pulumi_deployments’ format can only be used on stack or environment webhooks. Returns 404 if the webhook does not exist.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• hookName string path required
  The webhook name

Request Body

• organizationName string required
  The organization that owns this webhook.
• projectName string optional
  The project name. Set when the webhook is scoped to a specific stack.
• stackName string optional
  The stack name. Set when the webhook is scoped to a specific stack.
• envName string optional
  The environment name. Set when the webhook is scoped to a specific environment.
• name string required
  The unique identifier name for the webhook within its scope.
• displayName string required
  The human-readable display name shown in the UI.
• payloadUrl string required
  The URL to which webhook payloads are delivered.
• secret string optional
  Secret will be omitted when returned from the service.
• active boolean required
  Whether the webhook is active and will receive deliveries.
• format string optional
  The format of the webhook payload (e.g., ‘raw’, ‘slack’, ‘ms_teams’).
• filters array[string] optional
  Specific event types this webhook subscribes to. If empty, all events are delivered.
• groups array[string] optional
  Event groups this webhook subscribes to (e.g., ‘stacks’, ‘deployments’).

Responses

Deletes a webhook from the specified stack. Returns 204 with no content on success.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• hookName string path required
  The webhook name

Responses

Returns the recent delivery history for a specific webhook. Each delivery includes the timestamp, HTTP status code, request and response details, and whether the delivery was successful.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• hookName string path required
  The webhook name

Responses

Triggers the Pulumi Service to redeliver a specific event to a webhook. This is useful for resending an event that the webhook endpoint failed to process on the initial delivery attempt. Returns the delivery result with HTTP status and response details. Returns 404 if the webhook or event does not exist.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• hookName string path required
  The webhook name
• event string path required
  The webhook delivery event identifier to redeliver

Responses

Issues a test ping event to the specified webhook to verify it is properly configured and reachable. Unlike normal webhook deliveries, this bypasses the message queue and sends the request directly to the webhook endpoint. The response includes the delivery result with HTTP status and response details. Returns 404 if the webhook does not exist.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• hookName string path required
  The webhook name

Responses