Skip to content

Fetch a webhook event

GET
/api/v1/events/{id}

Returns one webhook event by the id a delivery carried (the body's id, or the Gaplessly-Event-Id header), in the same envelope the delivery had: id, type, createdAt and data: { object, changes }. For a receiver that cannot check Gaplessly-Signature, such as a no-code tool that only sees the parsed body: fetching the event with your key confirms Gaplessly sent it, and the answer is what to act on.

object is the booking, client, check, message or enquiry as it is now, built the same way the delivery built it at send time, so a change made since can show here first.

Scopes. webhooks:write plus the read scope for the event's data, the same pair subscribing to that event needs: reservations:read for a table booking, a till's check or an enquiry, appointments:read for an appointment, clients:read for guest.created and guest.merged, messages:read for message.received. A test ping needs only webhooks:write.

Kept 30 days, while its delivery log is. An event from another organization, one older than that, or one whose endpoint was removed is a 404, the same answer as an id that never existed. A 404 with code: subject_deleted means the event was real but what it was about has since been deleted.

Authorization

bearerApiKey webhooks:write
AuthorizationBearer <token>

Build with a test key (sk_test_...): it works only in your API sandbox and never emails or texts anyone. Scopes, errors and limits.

In: header

Scope: webhooks:write

Path Parameters

id*string

Event id, from the delivery's body id or its Gaplessly-Event-Id header.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/events/string"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "type": "booking.created",    "createdAt": "2019-08-24T14:15:22Z",    "data": {      "object": {},      "changes": {}    }  }}