Mail: Webhooks
List webhooks
Retrieve a paginated list of webhooks belonging to the given mail order. Supports filtering by mailbox and status. The webhook secret is never included; it is returned only when a webhook is created or its secret is regenerated.
get/api/mail/v1/orders/{orderId}/webhooks
Path parameters
orderIdstring required
Example:OR1a2b3c4d5e6f7g
Order resource ID
Query parameters
mailbox_idstring nullable
Example:AC1a2b3c4d5e6f7g
Filter by the mailbox resource ID the webhooks are attached to
status'active' | 'disabled' | 'paused' nullable
Example:active
Filter webhooks by status
pageinteger
Example:1
Page number
per_pageinteger
Example:25
Number of items per page
Response
Success response
Example response
{
"data": [
{
"id": "019683f8-1234-7abc-8def-0123456789ab",
"mailbox": {
"id": "AC1a2b3c4d5e6f7g",
"address": "user@example.com"
},
"name": "New message notifier",
"description": "Notifies our CRM when a new email arrives",
"events": [
"message.received"
],
"status": "active",
"url": "https://example.com/webhooks/incoming",
"created_at": "2026-07-23T12:00:00Z",
"updated_at": "2026-07-23T12:00:00Z"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 100
}
}