Introduction

Webhooks are a means for us to communicate with your system through callbacks based on subscribed events. This allows for the real-time receipt and handling of data from Okaya to your system.

When adding a webhook, you select the events to subscribe to, minimizing HTTP requests to your server by only subscribing to events you intend to handle.

Note: In Okaya, Webhooks are available only to API subscription owners.

Why Use Webhooks?

Webhooks notify you about events, enabling automated workflows once - for example - when a check-in happens.

Entity Types

Setting the Scope of Info You’d Like to Receive

Our API's events revolve around a series of entity types. You can assign your hooks to these events and entities.

Available entity types:

ENTITY TYPE	MEANING	EXAMPLE
user	Used to subscribe to events related to a specific participant being created

Entity Events

What Kind of Events Can Trigger the Webhook?

Entity events are create, update, or delete actions that might occur with a specific entity type.

User Events

EVENT TYPE	MEANING
user.created	Whenever we assign a new externalID to one of your participants (because they were not tracked in Okaya yet), we call your endpoint to notify you of the ID so you can store it and re-use it in the future.
user.session.result	An analysis has been completed on a specific session and the result is ready. You can now use this information to retrieve the specifics of the check-in.