Webhooks

Get a webhook message

Returns a webhook message with its payload and per-endpoint delivery attempts. The message ID matches the webhook-id header on the delivery.

get/v1/webhooks/messages/{messageId}

Path parameters

messageIdstring required
Example:msg_1234567890abcdef

The ID of the webhook message

Headers

X-API-Keystring

API key

Response

Webhook message retrieved successfully

idstring required
eventTypestring required
timestampstring date-time required
tagsstring[]

Resource IDs carried on the message

payloadobject nullable required

Request body delivered to the endpoint. Null when the payload has expired.

Example response

{
  "id": "msg_1234567890abcdef",
  "eventType": "transfer.completed",
  "attempts": [
    {
      "id": "atmpt_1234567890abcdef",
      "endpointId": "ep_1234567890abcdef",
      "endpointUrl": "https://api.example.com/webhooks",
      "statusCode": 200,
      "durationMs": 132
    }
  ]
}

Changes

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