Get Webhook Event

GET /webhooks/:webhookId/events/:webhookEventId

Gets a specific webhook event.

• Request headers required. See Request Headers for more information.

• Authentication required. See Authentication Headers for more information.

We only keep a trace of those Webhook Events in our system for a retention period of 31 days. Past that, they are discarded, so you cannot see them using List Webhook Events or Get Webhook Event endpoints.

Permissions Required

• Webhooks:Events:Read

Response

For more details on all possible contents in the data field, depending on which webhook event kind it is, check out Webhook Event Data.

{
  "id": "whe-123-xxxxxxx",
  "kind": "wallet.transfer.confirmed",
  "date": "2023-12-04T10:02:22.280Z",
  "deliveryFailed": true,
  "deliveryAttempt": 2,
  "timestampSent": 1701684144,
  "status": "500",
  "error": "Internal Server Error",
  "retryOf": "whe-456-xxxxxxx",
  "nextAttemptDate": "2023-12-04T12:02:22.280Z"
  "data": {
    ... // content depending on the kind of events it is
  },
}

Property	Type	Description
id	String	Webhook Event ID
kind	String	Event kind (see supported events)
date	String	ISO-8601 date string when the actual event happened in our system.
deliveryFailed	Boolean	Whether the delivery of this webhook event to your webhook url was successful or not. Any delivery which did not returned a 200 status code is considered failed, and will be retried (read more here)
deliveryAttempt	Number	Number of the delivery attempt. The first event attempt is 1, and then if it fails, another delivery attempt will be performed later, so deliveryAttempt increases (read more here)
timestampSent	Number	Unix timestamp (seconds) when the webhook event was signed and tried to deliver to your webhook url from our servers. Will be useful to validate the timestamp of the signature, to protect against replay attacks (more details here).
status	String	Response status of the webhook delivery attempt. Can be a http status code (eg "200" or "500") if your server responded, or another error code otherwise. This can be helpful to troubleshoot your webhook endpoint.
error	String - Optional	Error detail, if some error happened upon delivery attempt to your webhook endpoint.
retryOf	String - Optional	If this webhook event is a delivery retry from another event which failed delivering to your webhook, retryOf is the ID of the previously failed Webhook Event (more details here)
nextAttemptDate	String - Optional	If this webhook event has failed delivering, and is set to be retried later (has not reached maximum retries), this indicate the date around when the delivery retry will happen. (more details here)
data	Object	Object containing data related to the event kind (more details here)