CreateWebhookEndpointReq

  • eventTypes
    Type: array string[] · WebhookEventType[] 1…enum
    required

    Event types this webhook subscribes to. Must contain at least one — wildcards are not supported, list each event type explicitly. See WebhookEventType for the full set.

    values
    • workflow.started
    • workflow.failed
    • workflow.completed
    • workflow.declined
    • workflow.voided
    • Type: string · WebhookEventTypeenum

      Type of webhook event

      values
      • workflow.started
      • workflow.failed
      • workflow.completed
      • workflow.declined
      • workflow.voided
  • url
    Type: stringFormat: uri
    required

    HTTPS endpoint that will receive webhook deliveries. Must be reachable from the public internet — POSTs to localhost / private IPs are rejected.

  • description
    Type: string

    Free-text label shown in Studio and on the webhook endpoint response. Use it to disambiguate webhooks with similar URLs (e.g., "prod analytics pipeline" vs "staging replay").