Articles on: Integrations

API & Webhooks

API & Webhooks


Connect other apps or build on top of Uplisting

Use your API key to connect Uplisting to third-party apps, or to build your own tools on top of your Uplisting data.


Where to find your keys

Your API key is generated on the Connect > API page, here.
Your Webhook key is generated on the Connect > Webhook page, here.


Documentation

Uplisting API Postman collection


Building something for other Uplisting customers?

If you are building an integration you will offer to other Uplisting customers, or you need a Client ID, custom booking attributes or the V3 OAuth API, start here instead: API Partner Integration


Webhook responsiveness and disablement


If an endpoint fails to respond to 5 different events consecutively, our system will mark it as disabled.
How failed events are handled depends on the response received:

  • 4xx responses (excluding 408 and 429): These count as a failed event immediately, without further retries.
  • 5xx responses and timeouts: These are retried up to 21 times over approximately 8.4 days before counting as a failed event.


Once 5 different events have failed consecutively, the webhook is automatically disabled, and no further events will be posted to that endpoint.


Please note: We do not send a notification when a webhook is disabled. Please ensure your endpoint is reliable and responds within 5 seconds.



FAQ

These answers apply to the API key. If you are using the V3 OAuth API, see the V3 OAuth FAQ, as several of the answers differ:
How should the Authorization header be formed?
Use HTTP Basic auth with the Base64 encoded API key: Authorization: Basic <base64(api_key)>. Encode the key on its own, not in the usual key:password format.


Why am I getting 401 Unauthorized?
Most commonly the key has not been Base64 encoded correctly, or you are using a key from the wrong environment. Check for a trailing newline if you generated the encoding on the command line. You can test your key against the Verify API key endpoint in the Postman collection.


What are the rate limits?
5 requests per second per IP address, 100 per minute per IP address, and 15 per minute per property. Exceeding these returns a 429 Too Many Requests response.


How do I register webhooks?
Using your account API key, following the steps in the Postman collection. This is the same whether you are on the API key or V3 OAuth.


Our webhook stopped. What should we check first?
Confirm your endpoint returns a 2xx response within 5 seconds. If you stop receiving webhook events, check whether your webhook has been automatically disabled due to consecutive failed events. Please note that no notification is sent when a webhook is disabled.



Something else?
Send us your question using this form.

Updated on: 12/11/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!