Environments

ListWebhooks

Returns a list of all webhooks configured for a Pulumi ESC environment. Each webhook entry includes its name, destination URL, event filters, format, and active status. Webhooks enable external services to be notified of environment events such as updates and opens.

get/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

Response

successful operation

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.