> For the complete documentation index, see [llms.txt](https://resources.atriptech.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://resources.atriptech.com/api-document/readme/webhook-overview/incident-notification.md). # Incident Notification {% hint style="info" %} 💬 **Need help?** If you're stuck, ask Eva on ATRIP for instant diagnostics. Ask Eva {% endhint %} Use this webhook when Atlas detects an operational incident affecting an order. ### Trigger Atlas sends an incident notification for: * `email.schedulechange` * `order.schedulechange` * `abnormal.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 * `type` * `notificationId` * `status` * `data.orderNo` Then read incident-specific fields based on `type`. ### Incident types #### `email.schedulechange` Atlas received an airline schedule-change email.\ Use `data.emailSubject` and `data.emailLink`. #### `order.schedulechange` Atlas has structured schedule change data.\ Use segment arrays and `scheduleChangeType`. #### `abnormal.cancelled` An unexpected cancellation was detected.\ Use the order number and cancellation details for follow-up. ### Notes * `status` is incident confirmation state * `emailLink` is temporary and should be stored quickly if needed * register your webhook URL before relying on these events ### Example registration request ```json { "cid": "XXXXXXXX", "url": "https://xxx.com/xxxx" } ``` {% tabs %} {% tab title="Schema" %} **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: ``` { "cid": "XXXXXXXX", "url": "https://xxx.com/xxxx" } ``` 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: ``` { "cid":"xxxxxxxxxx", "type":"email.schedulechange", "notificationId":"20230323113246035DNIDD", "status":0, "data":{ "orderNo":"TESTS20230323103458265", "emailSubject":"IMPORTANT: Flight delay notice. Confirmation Code KDK7QG", "emailLink":"https://theatlas/#/email-detail/4378270" } } ``` 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: ``` { "cid": "xxxxxxxxxx", "data": { "orderNo": "XCEWF20221203094515954", "previousSegs": [ { "arrAirport": "DPS", "arrTerminal": "", "arrTime": "2023-01-24 10:35:00", "carrier": "IU", "codeShare": false, "depAirport": "CGK", "depTerminal": "", "depTime": "2023-01-24 07:45:00", "flightNumber": "IU740" }, { "arrAirport": "CGK", "arrTerminal": "", "arrTime": "2023-04-24 16:05:00", "carrier": "IU", "codeShare": false, "depAirport": "DPS", "depTerminal": "", "depTime": "2023-04-24 15:15:00", "flightNumber": "IU759" } ], "revisedSegs": [ { "arrAirport": "CGK", "arrTerminal": "", "arrTime": "2023-04-24 16:05:00", "carrier": "IU", "codeShare": false, "depAirport": "DPS", "depTerminal": "", "depTime": "2023-04-24 15:15:00", "flightNumber": "IU743" } ], "scheduleChangeType": 1 }, "notificationId": "20230424050252711WZDMB", "status": 0, "type": "order.schedulechange" } ``` 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: ``` { "cid": "xxxxxxxxxx", "data": { "orderNo": "RQWUV20230617185232880", "vendorRefundInformation": "FULLY" }, "notificationId": "20230906014000568DRLNX", "status": 0, "type": "abnormal.cancelled" } ``` {% endtab %} {% tab title="Samples" %} **Schedule Change-Email Notification** ```json { "cid":"xxxxxxxxxx", "type":"email.schedulechange", "notificationId":"20230323113246035DNIDD", "status":0, "data":{ "orderNo":"TESTS20230323103458265", "emailSubject":"IMPORTANT: Flight delay notice. Confirmation Code KDK7QG", "emailLink":"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: ```json { "cid": "XXXXXXXX", "url": "https://xxx.com/xxxx" } ``` 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: ```json { "cid":"xxxxxxxxxx", "type":"email.schedulechange", "notificationId":"20230323113246035DNIDD", "status":0, "data":{ "orderNo":"TESTS20230323103458265", "emailSubject":"IMPORTANT: Flight delay notice. Confirmation Code KDK7QG", "emailLink":"https://theatlas/#/email-detail/4378270" } } ``` 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: ``` { "cid": "xxxxxxxxxx", "data": { "orderNo": "XCEWF20221203094515954", "previousSegs": [ { "arrAirport": "DPS", "arrTerminal": "", "arrTime": "2023-01-24 10:35:00", "carrier": "IU", "codeShare": false, "depAirport": "CGK", "depTerminal": "", "depTime": "2023-01-24 07:45:00", "flightNumber": "IU740" }, { "arrAirport": "CGK", "arrTerminal": "", "arrTime": "2023-04-24 16:05:00", "carrier": "IU", "codeShare": false, "depAirport": "DPS", "depTerminal": "", "depTime": "2023-04-24 15:15:00", "flightNumber": "IU759" } ], "revisedSegs": [ { "arrAirport": "CGK", "arrTerminal": "", "arrTime": "2023-04-24 16:05:00", "carrier": "IU", "codeShare": false, "depAirport": "DPS", "depTerminal": "", "depTime": "2023-04-24 15:15:00", "flightNumber": "IU743" } ], "scheduleChangeType": 1 }, "notificationId": "20230424050252711WZDMB", "status": 0, "type": "order.schedulechange" } ``` 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: ``` { "cid": "xxxxxxxxxx", "data": { "orderNo": "RQWUV20230617185232880", "vendorRefundInformation": "FULLY" }, "notificationId": "20230906014000568DRLNX", "status": 0, "type": "abnormal.cancelled" } ``` {% endtab %} {% endtabs %} ### Related pages * [Webhook Registration & Incidents](/api-document/api-reference/webhook-and-incident-apis/webhook-registration-and-incidents.md) * [Incident Query](/api-document/readme/webhook-overview/incident-query.md) * [Schedule Change Notification](/api-document/readme/webhook-overview/schedule-change-notification.md) * [Email Notification](/api-document/readme/webhook-overview/email-notification.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://resources.atriptech.com/api-document/readme/webhook-overview/incident-notification.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.