WebhookEndpointListItem

  • Webhook endpoint as returned by GET /webhook-endpoints/{id} and GET /webhook-endpoints. The signing secret is not included — it's shown only once in the create / rotate-secret responses (CreateWebhookEndpointResp and RotateWebhookSecretResp). To recover from a lost secret, call POST /webhook-endpoints/{id}/rotate-secret.

    • _eTag
      Type: string
      required

      Optimistic-locking handle for this webhook endpoint. Carried in the body on list items because list responses can't multiplex per-item ETag headers. Pass back as If-Match on the next PATCH /webhook-endpoints/{id}.

    • createdAt
      Type: stringFormat: date-time

      When the webhook endpoint was created.

    • description
      Type: string

      Free-text label set on create / update.

    • eventTypes
      Type: array string[] · WebhookEventType[]enum

      Event types currently subscribed.

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

      Webhook endpoint ID. Stable for the life of the config — survives pause / resume and is preserved across secret rotations.

    • isActive
      Type: boolean

      true when the webhook is firing; false when paused. Paused webhooks don't count against the per-namespace cap of 4 active webhooks.

    • retryConfig
      Type: object

      Retry policy applied to failed deliveries (network errors, non-2xx responses).

    • updatedAt
      Type: stringFormat: date-time

      Last update to any field (URL, eventTypes, description, isActive, secret rotation).

    • url
      Type: stringFormat: uri

      Endpoint currently receiving deliveries for this config.