Skip to main content
POST

Authorizations

Authorization
string
header
required

API key for account management endpoints. Use your api_ prefixed token.

Body

application/json
uuid
string<uuid>

Filter by webhook config UUID

Example:

"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"

event_id
string

Filter by specific event ID

Example:

"evt_xyz789"

event_type
enum<string>

Filter by event type

Available options:
outbound.queued,
outbound.delivered,
outbound.bounced,
outbound.rejected,
outbound.deferred,
outbound.spam,
outbound.dropped,
outbound.virus,
outbound.opened,
outbound.clicked,
outbound.complaint,
inbound.received,
inbound.delivered,
inbound.spam,
inbound.blocked
Example:

"outbound.delivered"

source_uid
string

Filter by source message UID

Example:

"message-uid-123"

status
enum<string>

Filter by delivery status

Available options:
success,
failed,
retry,
pending
Example:

"success"

date_from
integer

Filter from Unix timestamp

Example:

1704825600

date_to
integer

Filter to Unix timestamp

Example:

1704912000

limit
integer
default:50

Maximum results to return

Required range: 1 <= x <= 1000
Example:

50

offset
integer
default:0

Pagination offset

Required range: x >= 0
Example:

0

Response

Webhook events retrieved successfully

events
object[]
total
integer

Total number of matching events

Example:

150

limit
integer

Limit used for this query

Example:

50

offset
integer

Offset used for this query

Example:

0