v1

latestOpenAPI 3.0.32026-07-264469137.7 KB

Webhooks

Retrieve a webhook event

Retrieve a single event's full payload and delivery attempts. Requires the webhooks:read scope.

get/v1/webhooks/events/{event_id}

Path parameters

event_idstring required

The event's ID.

Response

The event with its payload and attempts.

event_idstring required

Unique identifier for the event.

event_typestring required

The event type.

entity_typestring nullable

The kind of resource the event is about.

entity_idstring nullable

The resource the event is about.

created_atstring required

When the event occurred, in UTC.

payloadobject required

The full event payload that was (or would be) delivered.

Example response

{
  "event_id": "evt_1a2b3c4d5e",
  "event_type": "collection.succeeded",
  "entity_type": "charge",
  "entity_id": "pay_1a2b3c4d5e",
  "created_at": "2026-04-27T12:00:00Z",
  "attempts": [
    {
      "attempt_id": "wha_1a2b3c4d5e",
      "attempt_no": 1,
      "status": "delivered",
      "callback_url": "https://api.example.com/webhooks/bachs",
      "http_status": 200,
      "response_snippet": "ok",
      "created_at": "2026-04-27T12:00:01Z",
      "updated_at": "2026-04-27T12:00:01Z"
    }
  ]
}