Incident Notification
Webhook event sent for incident-level order changes such as email schedule change, API schedule change, or unaccounted cancellation.
Use this webhook when Atlas detects an operational incident affecting an order.
Trigger
Atlas sends an incident notification for:
email.schedulechangeorder.schedulechangeabnormal.cancelled
What you should do
When you receive this event:
identify the incident type
decide whether traveler action is needed
notify affected customers if required
use incident query or order query for follow-up investigation
Endpoint
POST to the webhook URL you registered with Atlas.
Fields to read first
typenotificationIdstatusdata.orderNo
Then read incident-specific fields based on type.
Incident types
email.schedulechange
email.schedulechangeAtlas received an airline schedule-change email.
Use data.emailSubject and data.emailLink.
order.schedulechange
order.schedulechangeAtlas has structured schedule change data.
Use segment arrays and scheduleChangeType.
abnormal.cancelled
abnormal.cancelledAn unexpected cancellation was detected. Use the order number and cancellation details for follow-up.
Notes
statusis incident confirmation stateemailLinkis temporary and should be stored quickly if neededregister your webhook URL before relying on these events
Example registration request
cid
Type: String
Required: Yes
Description: Unique client identifier for tracking the request.
Example:
"xxxxxxxxxx"
type
Type: String
Required: Yes
Description: Incident type.
Valid values:
email.schedulechange: Schedule Change-Email Notification
abnormal.cancelled: Unaccounted Cancellation
order.schedulechange: Schedule Change-API Notification
Example:
"email.schedulechange"
notificationId
Type: String
Required: Yes
Description: Unique identifier for the notification event.
Example:
"20230323113246035DNIDD"
status
Type: Integer
Required: Yes
Description: Incident status.
Valid values:
0: Unconfirmed
1: Confirmed
Example:
0
data
Type: Object
Required: Yes
Description: Contains details of the email notification related to the schedule change.
data.orderNo
Type: String
Required: Yes
Description: Unique order number associated with the flight booking.
Example:
"TESTS20230323103458265"
data.emailSubject
Type: String
Required: Yes
Description: Subject line of the email notification sent to the customer.
Example:
"IMPORTANT: Flight delay notice. Confirmation Code KDK7QG"
data.emailLink
Type: String (URL)
Required: Yes
Description: Direct link to the email details page for further information.
Example:
"https://theatlas/#/email-detail/4378270"
Tip: The customer’s server URL needs to be registered with Atlas to receive notifications via webhook.
This can be done via API as shown below:
The registration can also be done via ATRIP in the “Customer Information” tab of the “My Profile” menu.
Receiving notifications:
Three types of Incident notifications will be received. They are:
a. [Schedule Change – Email Notification] Any schedule change email notification received from the airline using Atlas generated email id.
Sample:
Please note that the email link has a validity period of 10 minutes. The data received in the email will need to be stored at the customer’s end.
b. [Schedule Change - API Notification]
Structured Notification of Schedule Change. Information on old and new flights.
Sample:
c. [Unaccounted Cancellation]
These are cancellations made by our customers, airlines or passengers themselves. This info will be sent to the customers to confirm the same and inform the customer, if necessary.
Sample:
Schedule Change-Email Notification
Tip: The customer’s server URL needs to be registered with Atlas to receive notifications via webhook.
This can be done via API as shown below:
The registration can also be done via ATRIP in the “Customer Information” tab of the “My Profile” menu.
Receiving notifications:
Three types of Incident notifications will be received. They are:
a. [Schedule Change – Email Notification] Any schedule change email notification received from the airline using Atlas generated email id.
Sample:
Please note that the email link has a validity period of 10 minutes. The data received in the email will need to be stored at the customer’s end.
b. [Schedule Change - API Notification]
Structured Notification of Schedule Change. Information on old and new flights.
Sample:
c. [Unaccounted Cancellation]
These are cancellations made by our customers, airlines or passengers themselves. This info will be sent to the customers to confirm the same and inform the customer, if necessary.
Sample:
Related pages
Last updated
Was this helpful?