This article reviews Tock's APIs and webhooks, which follow a standardized format and are not customizable. Tock is unable to provide guidance on any custom solutions a business chooses to implement using the resources below.
Documentation and Resources
Use these resources when setting up APIs and webhooks:
- Reservation Data Model: Reservation data made available via Tock APIs or webhooks may include the data referenced here. Any changes to this model will be additive.
- Guest Data Model: Guest data made available via Tock APIs or webhooks may include the data referenced here. Any changes to this model will be additive.
Available APIs and Webhooks
The following APIs and webhooks are available:
- Data Exports API: Twice daily export of all historical reservation and guest data.
- Guest Profile Ingest API: Add and update guest data in Tock, including guest profile tags.
- Inventory Availability API: Generate a list of available reservations that match a search criteria.
- Real-time Guest Profile Webhook: Subscribe to receive guest profile updates for all locations within a Tock business group.
- Real-time Reservation Webhook: Subscribe to receive all reservation updates for all locations within a Tock business group.
FAQ
Below are frequently asked questions about APIs and webhooks.
Do I qualify for API and Webhook access?
Premium and Premium Unlimited plans are eligible to receive API/ Webhook access. To verify eligibility, navigate to the Control Panel tab, then click Plan & Billing to see your plan.
Is it possible to pull available bookings for a restaurant (unbooked reservations)?
Yes, via the Inventory Availability API. Note, this API only provides inventory available on exploretock.com and doesn’t include any blocked or held inventory.
What data can be updated in Tock using an API?
Tock only allows creation and updating of basic guest information via the Guest Ingest API. Reservation data cannot be manipulated using an API.
Is it possible to create or cancel a reservation using the API?
No, reservation creations and cancellations must be done through the Tock dashboard.
How often is new data made available in the Exports API?
The export files are generated twice daily, with each file containing data that is updated as of 12 hours prior.
When do Webhooks fire?
Webhooks fire based on real-time updates to guest profiles or reservations.
Can only specific reservations be included in the Exports API?
All historical reservation data is included - processes should be implemented outside of Tock to filter and handle the data as needed.
What is the format of data being sent via an API?
All data available via Tock API or webhook is structured as a JSON object.
What's the difference between an API and a webhook?
- An API provides the ability to fetch or send data on demand.
- A webhook provides automatic updates when an event happens in Tock, like the edit of a reservation.
What is the process to request an API key?
Request your API key by emailing account-management@tockhq.com from an email address listed as an Account Owner on the business’ Tock Dashboard Team page.
What is the process to request a webhook?
Request your webhook by emailing account-management@tockhq.com from an email address listed as an Account Owner on the business’ Tock Dashboard Team page. Provide the following information:
- Desired webhooks (reservations, walk-ins, guest profile).
- Endpoint url for each requested webhook.
- Any required authorization headers (preferred format is without spaces or special characters, i.e. headername:headervalue).