Sign in
Webhooks

Get a webhook delivery payload

Changed on

Returns the retained JSON request body for one delivery attempt. Payloads are retained for 7 days and may no longer be available after payload_expires_at.

get/webhooks/{public_id}/deliveries/{delivery_id}/payload

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/webhooks/{public_id}/deliveries/{delivery_id}/payload
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: webhook.read)

Path parameters

public_idstring required

Webhook public ID

delivery_idstring required

Delivery-attempt public ID

Response

Delivery payload

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "created_at": "2026-05-21T09:12:00Z",
    "delivery_attempt": 1,
    "event_id": "evt_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "event_type": "message.bounced",
    "expires_at": "2026-05-28T09:12:00Z",
    "id": "whda_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "payload": {
      "data": {
        "bounce_subtype": null,
        "bounce_type": null,
        "complaint_subtype": null,
        "complaint_type": null,
        "delay_expires_at": null,
        "delay_type": null,
        "is_spam": false,
        "mailbox_id": "mbx_123",
        "message_id": "ME3P282MB076951B3AAD3255D686EA8EDCA0F2@example.com",
        "message_id_kind": "rfc5322",
        "recipients": [
          "inbox@example.com"
        ],
        "reject_reason": null,
        "sender": "sender@example.com",
        "sendmux_message_id": null,
        "webhook_id": null
      },
      "id": "evt_clxxxxxxxxxxxxxxxxxxxxxxxxx",
      "occurred_at": "2026-05-21T09:12:00Z",
      "team_public_id": "team_clxxxxxxxxxxxxxxxxxxxxxxxxx",
      "type": "message.received"
    }
  }
}

Changes