1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. Webhook

Webhook

    Webhook describes a webhook registered with the Pulumi Service. It may be registered to either an Organization, Stack or Environment.

    Properties

    • 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’).