Webhook Events Overview

The public IP address from which the webhooks are sent is

Once you've completed the setup steps, you can subscribe to events and enable webhooks. Contact your Client Manager and provide them with:

• A list of events to subscribe to
• The webhook URL
• If applicable, a Shared Secret or an API Key.

Webhook URL

The webhook URL is the endpoint where the events will be sent. Only one callback URL is supported for the Production environment and one for a Non-Production environment.

📘

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.

Event Structure and Content

Parameters for all events

Each event includes the following parameters:

Parameter Name	Condition	Data Type	Description
mkt_id		Integer	The ID of the WorkN Marketplace.
event_datetime		String	The date and time when the event was processed. Expected value: Date/time in UTC timezone of format YYYY-MM-DDTHH:MM:SS.
msg_id		String	Unique ID generated for this event.
ext_customer_id	If there is an enterprise	String	ATS Enterprise ID.
ent_id	If there is an enterprise	Integer	The unique ID of the WorkN Enterprise.
ext_branch_id	If there is a branch	String	ATS Branch ID.
branch_id	If there is a branch	Integer	The unique ID of the WorkN Branch.

Additional Parameters

Each event will have the following key values as well:

Key	Description
MessageDeDuplicationId	A unique identifier used for FIFO queues to ensure duplicate events are not processed. The format follows the following format: YYYY-MM-DDTHH:MM:SS.MS, where the T is an indicator for the Time portion and the time is in 24-hour format with both seconds and milliseconds. Example: 2025-02-12T14:30:45.123. Important: This value is only included if the queue is a FIFO queue.
MessageGroupId	Groups related messages within a FIFO queue to maintain ordering. Format: EventSetup_<WorkN Event Setup ID>, where <WorkN Event Setup ID> is a unique identifier for a specific event setup in WorkN. All events in the queue for the same setup share the same MessageGroupId. Important: This value is only included if the queue is a FIFO queue.

Next Steps

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