This repository contains OpenAPI specifications for ROOMZ's Public API.
Please contact the Sales team if you are interested in joining the private preview, which is expected to open in Mid-July 2024.
Receive ROOMZ events in your webhook endpoint and trigger reactions in your integration.
- When a resource changes, a Webhook event is posted to your webhook url.
- Your application receives an event and must respond to it.
For every change in resources, ROOMZ will post a WebhookEvent object to your webhook url. The WebhookEvent object is described in ROOMZ's OpenAPI Specification
You should ensure that your receiving url uses an HTTPS connection.
Your webhook secret will be used to generate a hash signature that is sent to your application with the event in order to ensure that it is from ROOMZ.
The hash signature is included as the value of the Roomz-Signature header.
The hash signature is generated using your webhook secret and the event payload.
For more information on how to verify the signature, see the signature verification documentation.
Your integration should respond with a 2xx status code response as fast as possible.
Any other status codes are considered a delivery failure.
You might want to process the event asynchronously. Your integration can respond when it receives the webhook, and then process the payload in the background.
Requests aren't time limited at the moment, but time-to-live is subject to change in the future.
Your webhook url might sometimes receive the same event multiple times.
To prevent receiving duplicate events, ensure your event handling is idempotent.
One method is to log processed events and avoid reprocessing those already logged.