Scribd
Upload
12 views4 pages

Webhook API Specification

The WebHook API Specification document outlines the process for sending shipment status updates from Aramex to a specified HTTP endpoint. It includes details on request headers, payload structure, and response status codes. The document emphasizes the importance of an authentication key for security and provides examples of the data format required for updates.

Uploaded by

januson.comorin
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
12 views4 pages

Webhook API Specification

The WebHook API Specification document outlines the process for sending shipment status updates from Aramex to a specified HTTP endpoint. It includes details on request headers, payload structure, and response status codes. The document emphasizes the importance of an authentication key for security and provides examples of the data format required for updates.

Uploaded by

januson.comorin
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

WebHook API Specification Doc

Version Date Author Description

1.0 05-Oct-2018 Vibin Valsalan Initial draft

1.1 17-July-2020 Vibin Valsalan Added order


number in response
Index
1. Webhook Post
Request Header
Request Payload
Webhooks are used to send Shipment Status updates by Aramex to an HTTP endpoint on one
of your Webservices. They are useful for when you want to be notified whenever there is an
important update on your shipment that you want to receive in your system. (eg: A shipment
delivered, Shipment Picked Up etc.).
All the Webhook updates are sent as a POST HTTP request to an endpoint that you are going
to provide to us along with an authentication key, so you can check if the notification is coming
from us. This authentication key is optional, but highly recommended.

To configure the webhook, get in contact with us.

1. Webhook Post

Request Header
Method URL(Preferred Endpoint)

POST /api/webhookUpdates

Type Params Values

HEADER x-api-key string

HEADER Content-Type application/json

X-API-KEY: Your API Authentication Key, it is optional however it is highly


recommended
Other alternative headers acceptable for security are x-api-token,
Authorization, Org-Id

Request Payload
Type Data

Payload {
"Key": "45496731234",
"Value": {
"WaybillNumber": "45496731234",
"UpdateCode": "SH005",
"UpdateDateTime": "2021-08-04T07:30:15Z",
"UpdateLocation": "Al Jawhara, Saudi Arabia",
"Comments": "Delivered to Test Consignee",
"ProblemCode": "",
"OrderNumber":""
}
}

Name Type Description

Key * string Aramex Airwaybill number

WaybillNumber * string Aramex Airwaybill number

UpdateCode * string Aramex Tracking Status Code (get in contact with us for complete list of status
codes)

UpdateDateTime * string Update date and time in YYYY-MM-DDTHH:MM:SSZ format

UpdateLocation * string Update Location name

Comments * string Any viewable comments on the tracking event

ProblemCode * string Aramex Tracking Problem Code (get in contact with us for complete list of
problem codes)

OrderNumber string Shipment Reference

2. Webhook Response

Status Code Value

200 OK - Everything went as planned.

You might also like