These docs are for v1.0.0. Click to read the latest docs for v2.0.0.


Frequently asked questions

Why isn't my API key working?

There may be a typo in the key.
The account holder might have regenerated the key.

How can I test that the Webhook subscription is configured correctly?

You can use a service like Webhook Tester to test your endpoint and make sure you are configured correctly to start receiving booking data.

How can I sign up for a trial account?

To use the API you will need a OnceHub account. If you don't have an account yet, you can sign up for a trial account here.

Why am I not receiving a data payload from my Webhook subscription?

Check that you have enabled the correct event triggers. Learn more about event triggers

Check that your endpoint is set up correctly. Learn more about configuring your Webhook subscriptions

Why am I seeing null fields in the Webhook payload?

The Webhook payload returns a consistent data structure no matter what booking event type triggered it. For any given booking event type, some of the fields in the data object of the Webhook payload will not be relevant. Fields with no values will appear as null.

If my server is down will you send the payload again?

Yes. If for some reason your endpoint does not successfully receive the Webhook payload, we will continue trying to send the HTTP POST message every hour, for up to three days.