Requiring Confirmation for Bookings
Overview
The "Hold" feature in our booking system allows you to set bookings to a pending state that requires confirmation before they are fully confirmed. When this mode is enabled, bookings remain in a "Hold" status for a specified timeout period. If the booking is not confirmed within this time frame through the API, it is automatically canceled.
Configuration
Step 1: Enable the Hold Mode
To enable the hold mode for a booking, go to the event-type configuration settings and select the "Hold" option under Booking Behaviour. You will also need to define the timeout duration. This duration dictates how long the booking will stay in the "Hold" status before it is automatically canceled if not confirmed.
{
"eventType": {
"bookingBehaviour": {
"type": "HOLD",
"timeout": "PT1H"
}
}
}
Step 2: Confirm or Cancel the Booking
When a booking is placed in hold status, it will trigger associated webhooks, such as sending an email or SMS notification to the user. During this period, you can confirm the booking using the API endpoint:
- Confirm a held booking
- Cancel a held booking
If the confirmation endpoint is not called within the specified timeout duration, the booking will automatically move to the "Cancelled" status, and the associated cancellation webhooks will be triggered.