webhooks

Read one event's deliveries

Returns one event by its ID (the payload id), with every delivery attempt made for it across the account's webhooks, newest first. Use it when your receiver reports a missing or duplicate notification: the attempts show which webhooks were tried, when, and how each answered. Attempts to a webhook deleted since have a null webhook_id. A 404 means no recent event has this ID. Page through attempts with limit, cursor and attempts_next_cursor.

get/v1/webhooks/events/{event_id}

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/webhooks/events/{event_id}
  • Auth: HTTP bearer

Path parameters

event_idstring required

Event ID: a delivered payload's id, or one listed by recent events.

Query parameters

limitinteger

Results per page.

cursorstring

attempts_next_cursor from the previous response for this event.

Response

Success.

idstring required

Event ID, the same as the delivered payload's id. Deduplicate on it.

type'message.received' | 'message.sent' required

message.received: a received message is ready to read. message.sent: the provider accepted a sent message, which is not delivery.

accepted_atstring date-time required

When the event was handed to delivery; the payload's timestamp is when the mail event happened.

inbox_idstring nullable required

Cherami resource ID.

message_idstring nullable required

Cherami resource ID.

attempts_next_cursorstring nullable required

Cursor for more of this event's attempts; null at the end.

Changes

No recorded changes to this operation across all 1 revision of this API.