API Reference

Overview

Our API uses webhooks to send real-time updates about reservations to your specified URL. This allows you to receive immediate notifications when reservation events occur, without the need to continuously poll our API.

Payload

When a webhook is triggered, a POST request is sent to your specified URL with the following payload structure:

{
    "type": "reservation",
    "document": {
        // Reservation data (see /api/getReservation)
    }
}

Events

Webhooks are triggered for the following reservation events:

  1. Reservation created
  2. Reservation updated
  3. Reservation cancelled

The specific event type is not included in the payload but can be inferred from the reservation status and date fields.