Skip to content
AurionAI

Developer API: usage and webhooks

3 min readBy Emmanuel Yazbeck

The developer API pages show how programs use the AurionAI API, and let you send AurionAI events to your own systems with webhooks.

Availability: all profiles. Administrators only.

Prerequisites

  • You have the Owner or Admin role. Other roles cannot open these pages.
  • For webhooks: an HTTPS address on your side that accepts POST requests with a JSON body.

Open the developer API pages

  1. In the top bar, select your name or picture to open the user menu.
  2. Select Tenant Settings.
  3. Go to the Developer API card.
  4. Select API usage dashboard or Webhook management.

The Developer API card on the Tenant Settings page.

Review API usage

The "API Usage Dashboard" page shows the traffic of the AurionAI API for your organization.

  1. Under "Window", choose "Last 1 day", "Last 7 days" or "Last 30 days". The default is seven days.
  2. Read the four totals: "Total Requests", "Error Rate", "Rate-Limit Hits" and "Webhook Success".
  3. Read "Top API Paths" to see which addresses are called most, with their errors.
  4. Read "Daily Trend" to see the traffic per day.
  5. Select "Refresh" to load the latest numbers.

Register a webhook

  1. On the "Webhook Management" page, go to "Create Subscription".
  2. In "Target URL", type the HTTPS address of your receiver.
  3. Under "Events", select the events that you want to receive. The events are grouped: conversations, messages, contacts, tickets, calls, knowledge base and system.
  4. Select "Create webhook".
  5. A dialog shows the signing secret. Select "Copy secret" and store the secret in a safe place. AurionAI shows it only this one time.
  6. Select "I have saved my secret".

The new webhook appears under "Subscriptions" with the status "Active".

Verify a webhook signature

Each delivery is a POST request with a JSON body and these headers:

  • X-Webhook-Event: the name of the event, for example ticket.created.
  • X-Webhook-Timestamp: the time of the delivery.
  • X-Webhook-Signature: the signature of the delivery.

To check that a delivery comes from AurionAI:

  1. Take the value of X-Webhook-Timestamp, a dot, and the raw body of the request, in this order.
  2. Compute an HMAC-SHA256 of this text with your signing secret.
  3. Write the result in hexadecimal and compare it with X-Webhook-Signature. Accept the delivery only when they are equal.

Test, pause or delete a webhook

  • Select "Send test" to send a test delivery. A paused webhook cannot receive a test.
  • Select "Pause" to stop deliveries for a while, and "Resume" to start them again.
  • Select "Delete" and confirm to remove the webhook.
  • The page lists the latest deliveries, with their status, the number of attempts and the HTTP status of your receiver.

Result

AurionAI sends each selected event to your address. A delivery counts as successful when your receiver answers with a 2xx status. Otherwise AurionAI tries again later, up to five attempts in total.

If something goes wrong

  • "Webhook URL is required." Type the address of your receiver.
  • "Select at least one event to subscribe to." Select at least one event.
  • A message says that the webhook URL must start with https. AurionAI sends webhooks only to HTTPS addresses.
  • A message says that the address is blocked or cannot be resolved. AurionAI refuses private, local and unknown addresses. Use a public address that resolves in DNS.
  • The signature does not match. Use the raw body as received, before any parsing. Use the secret of this webhook. If you lost the secret, delete the webhook and create it again.
  • Deliveries fail. Check the HTTP status in the delivery list. Your receiver must answer with a 2xx status.
  • "No webhooks configured" under "Webhook Success". Your organization has no developer webhook yet.

Still stuck? Submit a request or .