Webhook Subscriptions

Webhooks allow Oquira to send real-time notifications to your server when specific events occur in your organization.

Available Events

Setting Up Webhooks

1. Log in to your Oquira Business.
2. Go to Settings > Webhooks.
3. Click Add Endpoint.
4. Enter your endpoint URL (must be HTTPS) and select the events you want to listen to.
5. Copy your Webhook Secret to verify signatures.

Security: Verifying Signatures

Oquira signs every webhook request with your secret to ensure authenticity. The signature is sent in the X-Oquira-Signature header.

Example Header

X-Oquira-Signature: t=1710936000,v1=sha256_hash_here

Verification Steps

1. Extract the timestamp t and the signature v1.
2. Construct the signed payload by concatenating the timestamp and the JSON request body.
3. Compute an HMAC with the SHA256 hash function using your Webhook Secret.
4. Compare your result with the signature v1.

Delivery Guarantees

• Retry Policy: If your server returns a non-2xx status code, Oquira will retry the delivery up to 5 times with exponential backoff.
• Timeout: Oquira expects a response within 10 seconds.
• Ordering: Oquira does not guarantee the order of event delivery. Use the timestamp field in the payload to handle ordering if necessary.

Payload Example

{
  "id": "evt_abc123",
  "type": "ticket.called",
  "organizationId": "org_xyz789",
  "data": {
    "ticketId": "clsh8a2b3000208l2bh3z6p9k",
    "ticketLabel": "A-045",
    "queueId": "clsh7z8m1000008l2bh3z6p9k",
    "counter": "Counter 1",
    "status": "called",
    "calledAt": "2024-03-15T11:15:00.000Z"
  },
  "timestamp": "2024-03-15T11:15:00.000Z"
}