Webhook Registration & Incidents
Atlas API webhook registration and incident query reference for endpoint setup, updates, and event reconciliation.
FAQ
When should we register the webhook URL?
When should we query incidents?
How should fulfillment-flow orders use webhook and incident query?
What this page covers
What comes next?
Typical flow
Use this when you need
Registration scope
Related pages
application/jsonapplication/jsongzip<YOUR_CLIENT_ID><YOUR_CLIENT_SECRET>The URL for receiving webhook notifications
It serves as an additional description of the response result. Especially when the interface reports an error (status !=0), it is usually a human-readable error message. Note: Do not use this field in any programming scenarios. For example, do not judge whether the interface responds successfully based on this field. Instead, you should only determine it by checking whether the status is equal to0at any time.
POST /updateWebhookURL.do HTTP/1.1
Accept: text
Accept-Encoding: text
x-atlas-client-id: text
x-atlas-client-secret: text
Content-Type: application/json
Content-Length: 47
{
"cid": "XXXXXXXX",
"url": "https://xxx.com/xxxx"
}{
"status": 0,
"msg": "success"
}application/jsonapplication/jsongzip<YOUR_CLIENT_ID><YOUR_CLIENT_SECRET>Incident ID
Order number
Incident type:
email.schedulechange: Schedule Change-Email Notificationabnormal.cancelled: Unacounted Cancellationorder.schedulechange: Schedule Change-API Notification
Order's pnr.
Order's passenger names.
Order's passenger Email. Email address passed to the Airline.
Airline IATA code.
A list containing incident stauses
0: Unconfirmed1: Confirmed
Incident Receiving Time Start Format: yyyy-MM-dd HH:mm:ss UTC+08:00
Incident Receiving Time End Format: yyyy-MM-dd HH:mm:ss UTC+08:00
Departure Time Start(Departure local time) Format: yyyy-MM-dd HH:mm:ss
Departure Time End(Departure local time) Format: yyyy-MM-dd HH:mm:ss
Pagination
1Number of records per page
Current pagination
Page size
Total number of records
POST /event/getPageList.do HTTP/1.1
Accept: text
Accept-Encoding: text
x-atlas-client-id: text
x-atlas-client-secret: text
Content-Type: application/json
Content-Length: 218
{
"eventId": "",
"orderNo": "",
"eventType": "",
"eventStatus": [
0,
1
],
"airline": "",
"eventTimeStart": "2023-04-01 00:00:00",
"eventTimeEnd": "2023-05-01 00:00:00",
"depTimeStart": null,
"depTimeEnd": null,
"pageIndex": 1,
"pageSize": 100
}{
"records": [
{
"eventId": "20230401003644225YJQGR",
"orderNo": "HCNMN20230227142411968",
"subOrderNo": "HCNMN20230227142411968_1",
"eventType": "email.schedulechange",
"eventStatus": 0,
"eventTime": "Apr 1, 2023 12:36:44 AM",
"extraInfo": "4775822",
"confirmedResult": null,
"confirmedRemark": null,
"clientCode": "TAC00001",
"createTime": "Apr 1, 2023 12:36:44 AM",
"updateIme": "Apr 1, 2023 12:36:44 AM",
"airline": "F9",
"depTime": "Mar 31, 2023 11:12:00 AM",
"confirmTime": null,
"confirmUsr": null,
"notified": 1,
"pnr": "G7ZNW5",
"paxName": "SOWERS/REBECCA MUSETTA,STEPHENS/DAVID JEROME",
"paxEmail": "GeraldineDushkin2005@ttjipiao.top"
},
…
]
}Last updated
Was this helpful?

