Webhook Events

Suggest Edits

Webhooks provide a way to send automated notifications to your system when the specific events occur. Instead of manually checking for updates, you can subscribe to the relevant event and receive a JSON payload notification containing some information about the event. This article provides details on how to set up webhooks.

Setup

To enable webhooks, follow these steps:

  1. Define the events you want to subscribe to. In case you need assistance with this step, reach out to your Client Manager (for Avionté clients) or the Avionté+ Integration contact (for partners).
  2. Create a webhook URL that will receive the event notifications. For more details on setting up the webhook URL, refer to the Webhook URL section below.
  3. If the webhook endpoint requires authentication, obtain either a Shared Secret or an API Key. See the Authentication section for details.

Once you've completed the setup steps, you can subscribe to events and enable webhooks:

  • Avionté Clients: Contact your Client Manager and provide them with the list of events, webhook URL and, if required, either a Shared Secret or an API Key.
  • Avionté partners: Get in touch with the Avionté+ Integration contact and provide them with the list of events, webhook URL and, if required, either a Shared Secret or an API Key.

Webhook URL

The webhook URL is the endpoint where the events will be sent. You can set up either a single URL to be called for each event or have a separate URL for each event. Using a single URL is the simpler and recommended approach.

📘

Important

Make sure your endpoint URL uses HTTPS and can receive a POST request from Avionté.

Authentication

There are two types of authentication supported for webhook events. You can use either of these authentication options:

  • Shared Secret: Include a shared secret as the header variable X-Payload-Signature.
  • API key: Include the API Key as the header variable X-api-key.

Request Handling

Once your webhook is set up, a POST request is made to the endpoint, sending the event data as the request body in JSON format.

After sending the request, an HTTP 200 or 201 response code is expected if your system accepts the message. In case of a response with an HTTP status code in the range of 4xx or 5xx, the request is retried according to the following schedule:

  1. Immediate attempt.
  2. After waiting for one minute, a third attempt is made.
  3. Another immediate attempt is made for the fourth and final time. If the request still fails, it is escalated to an internal queue for further analysis of the failure.

Next Steps

After completing the setup process, explore the dedicated pages that provide detailed information about each event.

Updated 8 months ago