Skip to main content
GET
List webhook delivery attempts

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Path Parameters

public_id
string
required

Webhook public ID

Query Parameters

cursor
string

Pagination cursor — the next_cursor from the previous response.

limit
integer

Maximum results (default 25, max 100)

Required range: 1 <= x <= 100
event_type
enum<string>

Filter by event type.

Available options:
message.delivered,
message.bounced,
message.complained,
message.rejected,
message.delivery_delayed,
message.received,
message.received.spam,
sendmux.test
Example:

"message.bounced"

result
enum<string>

Filter by delivery result.

Available options:
success,
retrying,
failed,
permanent_failure

Response

Delivery-attempt list

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object[]
required
pagination
object
required