WebhookDeliveryListItem

Trimmed delivery shape returned by GET /webhook-deliveries and other list endpoints. Drops the full payload envelope and per-attempt detail (response body, error message). Fetch GET /webhook-deliveries/{id} for the full WebhookDeliveryResp when you need to drill in.

  • attemptCount
    Type: integer
    required

    Number of attempts made so far. Equivalent to attempts.length on the full delivery.

  • createdAt
    Type: stringFormat: date-time
    required

    When the event fired and the delivery was queued.

  • eventId
    Type: string Pattern: ^evt_[0-9a-z]{26}$
    required

    Stable per-event identifier — same across retries; safe to use as a dedup key on the consumer side. Prefixed lowercase ULID, e.g. evt_01jv8m7qfj6xj9gkz7a4s2h8e.

  • eventType
    Type: string · WebhookEventTypeenum
    required

    Type of webhook event

    values
    • workflow.started
    • workflow.failed
    • workflow.completed
    • workflow.declined
    • workflow.voided
  • id
    Type: string Pattern: ^wd_[0-9a-z]{26}$
    required

    Delivery ID. Prefixed lowercase ULID, e.g. wd_01jv8m7qfj6xj9gkz7a4s2h8e.

  • status
    Type: stringenum
    required

    Delivery state. pending = queued or in-flight; success = a 2xx response was received; failed = retry budget exhausted.

    values
    • pending
    • success
    • failed
  • updatedAt
    Type: stringFormat: date-time
    required

    Last touched timestamp — bumps on every attempt and status transition.

  • webhookEndpointId
    Type: string Pattern: ^we_[0-9a-z]{26}$
    required

    ID of the webhook endpoint this delivery belongs to. Prefixed lowercase ULID, e.g. we_01jv8m7qfj6xj9gkz7a4s2h8e.

  • envelopeKey
    Type: string

    Envelope key that triggered this event, when applicable.

  • lastAttempt
    Type: object

    Summary of the most recent attempt. Absent when no attempt has run yet.

    • attemptedAt
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • errorMessage
      Type: string

      Reason the attempt failed when no HTTP response was received (e.g., ETIMEDOUT).

    • responseStatus
      Type: integer

      HTTP status code returned by the customer endpoint. Absent when the request couldn't complete (network error / timeout) — see errorMessage.

  • nextRetryAt
    Type: stringFormat: date-time

    When the next retry will fire, when status: pending and at least one attempt has failed. Absent on success, failed, and on the first attempt before any failure.

  • participantEmail
    Type: string

    Email of the participant the event is about, when applicable.

  • stepKey
    Type: string

    Workflow step key that triggered this event, when applicable.

  • workflowId
    Type: string Pattern: ^wf_[0-9a-z]{26}$

    ID of the workflow that triggered this event, when applicable. Prefixed lowercase ULID, e.g. wf_01jv8m7qfj6xj9gkz7a4s2h8e.