Receive real-time notifications about events in your organization.
Webhooks allow you to receive HTTP POST notifications when specific events occur within your organization. This is useful for synchronizing data with your own systems or triggering external workflows.
Currently supported events:
| Event | Description |
|---|---|
ticket.created | A customer joins a queue. |
ticket.called | An operator calls a ticket to a service point. |
ticket.served | An operator starts serving a customer. |
ticket.completed | The service session for a ticket is finished. |
ticket.cancelled | A ticket is cancelled by the customer or operator. |
queue.status_changed | A queue is paused, resumed, or closed. |
All webhook requests follow a consistent JSON structure.
{
"id": "evt_abc...",
"type": "ticket.called",
"organizationId": "org_123...",
"createdAt": "2024-01-02T10:05:00Z",
"data": {
"ticketId": "clsh8a2b3000208l2bh3z6p9k",
"number": 15,
"displayCode": "A15",
"queueId": "clsh7z8m1000008l2bh3z6p9k",
"operatorId": "clsh8f8g9000508l2bh3z6p9k",
"status": "called",
"calledAt": "2024-03-15T11:15:00.000Z"
}
}Oquira signs all webhook payloads with a shared secret. You should verify this signature to ensure the request came from Oquira.
The signature is sent in the X-Oquira-Signature header.
Currently, webhooks can be configured via the Organization Settings in the dashboard or via the API.
POST /v1/organizations/{organizationId}/webhooks
X-API-Key: your_api_key_here
Content-Type: application/json
{
"url": "https://your-api.com/webhooks",
"secret": "your_shared_secret",
"events": ["ticket.called", "ticket.completed"]
}