Sign in
Webhook Deliveries

List webhook deliveries

Changed on

Returns a paginated list of webhook delivery attempts, newest first. A delivery of an inbound email includes a nested email object with sender, recipient, and subject. A delivery of an opt-in sent_email.* event has email_id and email set to null and sent_email_id set to the send it is about. Filter by event_type and sent_email_id to find the deliveries of one send.

get/webhooks/deliveries

Request

  • Base URL: https://api.primitive.dev/v1
  • URL: https://api.primitive.dev/v1/webhooks/deliveries
  • Auth: HTTP bearer

Query parameters

cursorstring

Pagination cursor from a previous response's meta.cursor field. Format: {ISO-datetime}|{id}

limitinteger

Number of results per page

email_idstring uuid

Filter by email ID

event_typestring

Only deliveries of this event type, for example sent_email.failed. Deliveries recorded before event types existed have none and never match.

sent_email_idstring uuid

Only deliveries of sent_email.* events about this sent email.

status'pending' | 'delivered' | 'header_confirmed' | 'failed' | 'skipped_by_rules'

Filter by delivery status

date_fromstring date-time

Filter deliveries created on or after this timestamp. An ISO 8601 timestamp with Z or a numeric UTC offset (2026-10-02T00:00:00Z, 2026-10-02T00:00:00-04:00). An offset is read as the instant it names. A time with no zone, or a bare date, is rejected.

date_tostring date-time

Filter deliveries created on or before this timestamp. An ISO 8601 timestamp with Z or a numeric UTC offset (2026-10-02T00:00:00Z, 2026-10-02T00:00:00-04:00). An offset is read as the instant it names. A time with no zone, or a bare date, is rejected.

Response

Paginated list of deliveries

successboolean required

Changes

  • 294207b6de5fRevision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • warning

      added the new skipped_by_rules enum value to the /// response property for the response status

    • info

      added the new optional query request parameter event_type

    • info

      added the new optional query request parameter sent_email_id

    • info

      added the new enum value skipped_by_rules to the query request parameter status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 52138fa51360Revision changes
    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status