Webhooks

Rather than polling the API for changes, you can subscribe to webhooks. Getme sends an HTTP request to an endpoint you control whenever a relevant event occurs, such as an order being placed, a booking being confirmed, or a website publish request being applied.

Webhook delivery uses the same public identifier and API versioning model as the REST API. Event names, scopes, payload examples, and payload field summaries are generated from the public event contracts.

Event catalog

The generated event catalog is the source to use when choosing subscriptions for an endpoint. It groups public events by domain and links each event to its payload contract and example delivery.

Delivery shape

Every delivery uses a common event envelope. The exact data.object shape depends on the event type and is documented in the event catalog.

{
  "id": "wevt_Abcdef1234567890Ghijk",
  "object": "event",
  "api_version": "2026-06-09",
  "type": "booking.cancelled",
  "created": "2026-06-09T12:00:00Z",
  "environment": "test",
  "livemode": false,
  "data": {
    "object": {
      "id": "book_example",
      "object": "booking",
      "metadata": {
        "example": true
      }
    }
  }
}

Important fields:

• id — the public webhook event identifier.
• type — the event name, such as booking.cancelled.
• api_version — the API version used to shape the payload.
• environment — test or live.
• livemode — false for test deliveries and true for live deliveries.
• data.object — the event-specific public payload.

Payload contracts

Payloads only contain public-safe fields. Internal database IDs, secrets, and implementation-only fields are excluded before delivery and validated against the generated public webhook payload contracts.