Skip to content
AurionAI

Notification webhooks

3 min readBy Emmanuel Yazbeck

A notification webhook sends AurionAI notification events to another system, for example a chat tool. AurionAI posts each event as a JSON body to the address that you enter.

Availability: Helpdesk and AI Voice + Helpdesk profiles. Administrators only.

Prerequisites

  • You have the Owner or Admin role. Other users see Access Denied.
  • Your organization uses the Helpdesk or the AI Voice + Helpdesk profile.
  • A public HTTPS address that accepts POST requests with a JSON body.

Open the notification webhooks

  1. In the sidebar, select Configuration.
  2. Open the System category.
  3. Select Webhooks.

The Notification Webhooks page with the list of webhooks.

Add a webhook

  1. Select Add Webhook.
  2. In Name, type a name.
  3. In URL, type the address. It must start with https://.
  4. Optional: in Secret (optional), type a secret. AurionAI then signs each request. Leave it empty to send unsigned requests.
  5. Choose the events:
    • To receive every notification event, turn on Subscribe to all events.
    • Otherwise, select the events in the list.
  6. Select Create.

The message Webhook created appears. A new webhook is Enabled.

Test the webhook

  1. On the webhook, select Test.
  2. In the Send a test payload? dialog, select Send test.

AurionAI sends a webhook.test event at once. The message Test payload sent successfully or Test payload failed appears.

Verify the signature

When the webhook has a secret, each request has two more headers:

  • X-Webhook-Timestamp: the time of the request, in seconds since 1 January 1970 (UTC).
  • X-Webhook-Signature: sha256= followed by the signature.

To check a request, compute an HMAC-SHA256 of the timestamp, a dot and the raw body, with your secret. Write the result in hexadecimal. It must equal the part after sha256=.

Edit, disable or delete a webhook

  • To change a webhook, select Edit Webhook, change the fields and select Save. Leave the secret empty to keep it, or select Remove secret to send unsigned requests.
  • To stop deliveries for a while, open Edit Webhook and turn the switch to Disabled. Then save.
  • To remove a webhook, select Delete. In the Delete this webhook? dialog, select Delete webhook. This also removes its delivery history and its secret. You cannot undo this.
  • To see past deliveries, select History on the webhook. Each line shows Delivered, Failed or Skipped, with the reason of a failure.

Result

AurionAI sends each selected event when it happens. If your address does not answer, or answers with a 5xx status, AurionAI tries again at once, up to three attempts in total. A 4xx answer is final: AurionAI does not try again.

If something goes wrong

  • The URL must start with https://. Start the address with https://.
  • Cloud metadata endpoints are always blocked. or a message that an IP address is in a blocked range. AurionAI does not send webhooks to private or internal addresses. Use a public address.
  • A message says that DNS resolution failed. The host name does not exist, or it has no DNS record. Check the address.
  • Select at least one event, or choose “Subscribe to all events”. Select at least one event, or turn on Subscribe to all events.
  • Test payload failed Read the reason, the HTTP status and the number of attempts in the message. Check that your receiver is online and answers with a 2xx status.
  • This webhook is disabled Enable the webhook first. If you select Send anyway, AurionAI only records a skipped attempt.
  • A delivery shows Skipped. The webhook was disabled, or the address failed the safety check before sending. Read the reason in the history.
  • Couldn't load webhooks or Couldn't load notification events Select Retry.

Still stuck? Submit a request or .