Skip to content

Unsubscribe a webhook

delete/api/v1/webhooks/{id}

Removes an endpoint this same key registered, with its delivery log. An endpoint added in the dashboard or by another key is a 404, the same as one that does not exist.

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

Webhook id, from the create response.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/webhooks/string"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "deleted": true  }}

Subscribe a webhookPOST

Registers an https endpoint for booking and guest events, owned by the calling key: what an automation tool calls when a user switches a trigger on (REST hooks). The same endpoints, signature (`Gaplessly-Signature`), retries and address rules as webhooks added in the dashboard; see the webhooks guide for verifying a delivery. **Each event also needs the read scope for its data**, because a webhook pushes what a list endpoint would return: `booking.created`, `booking.updated` and `booking.cancelled` need `reservations:read` (or `appointments:read`), and `guest.created` and `guest.merged` need `clients:read`. `check.updated` (a till's check total, table reservations only; an appointments business is a `400`) needs `reservations:read`. `message.received` (a guest's message, with its text) needs `messages:read`. `enquiry.created` and `enquiry.updated` (a big group's enquiry, table reservations only) need `reservations:read`. Without it the answer is `403 insufficient_scope` naming the missing scope. Only the key that registered an endpoint can remove it, and revoking the key removes all of its endpoints. At most 3 per key, within the organization's 10. A test key's endpoint hears only its sandbox's bookings. The signing `secret` is in this response and nowhere else. **Safe to retry.** A key subscribing a URL it already subscribed gets that endpoint back with `200`, secret included, rather than a second endpoint that would deliver every event twice. A repeat does not change the events; to change them, unsubscribe and subscribe again.

Fetch a webhook eventGET

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.