1. Webhook
Flype Order API Gulf
  • UAE API Integration Guide
    • Introduction
    • Shipments
      • Service Coverage
      • Shipments Count
      • All Shipments
      • Create Bulk Orders
      • Schedule Pickup
      • Shipment Details
      • Shipment Last Status
      • Cancel Shipment
      • Get AirwayBill
    • Locations
      • Get Cities
      • Get All Countries
    • Webhook
      • Shipment Status Updates Webhook
        POST
    • Schemas
      • Error
      • ServiceType
      • TrackingStatusName
      • PickupLocation
      • RecipientAddress
      • pickupLocation
      • Parcel
  1. Webhook

Shipment Status Updates Webhook

POST
/flype/webhook/shipment-status

Webhook - Shipment status updates (optional)#

This is not an API endpoint that the partner calls. Instead, the partner must provide Flype with a webhook URL where shipment status updates should be sent.
After the webhook is configured by Flype, Flype will send a POST request to the partner's webhook URL whenever a shipment status changes.

Information required from the partner#

  • webhookUrl - The full HTTPS URL where Flype should send shipment status updates.
  • authenticationMethod - The authentication method required by the partner's webhook, if any.
  • authorizationHeader - The header value Flype should include when calling the webhook, if required.

Webhook request method#

  • Method: POST
  • Content-Type: application/json
  • Direction: Flype → Partner server

Partner server requirements#

  • The webhook URL must be publicly reachable by Flype.
  • The webhook URL should use HTTPS.
  • The partner's server should accept POST requests with a JSON request body.
  • The partner's server should return a 2xx response when the webhook is received successfully.
  • The endpoint should be idempotent, so repeated webhook events do not create duplicate or incorrect shipment updates.

Authentication#

If the partner requires authentication for webhook requests, they must provide Flype with the required authentication details.
For example, if the partner requires a Bearer token, Flype can include it in the request header:
Authorization: Bearer <partner_provided_token>

Important notes#

  • This webhook is hosted by the partner, not by Flype.
  • The partner does not call this endpoint. Flype calls the partner's webhook URL.
  • Flype must configure the webhook URL before shipment status updates can be sent.
  • The payload will contain the shipment tracking number and the latest shipment status details.

Summary#

Provide Flype with your webhook URL and authentication requirements. Once configured, Flype will send shipment status updates to your server in near real time.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/jsonRequired

Example
{
    "trackingNumber": "F78ECYH0BNZ8",
    "status": "delivered",
    "orderDate": "2025-10-30T15:12:34.000Z"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/flype/webhook/shipment-status' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "trackingNumber": "F78ECYH0BNZ8",
    "status": "delivered",
    "orderDate": "2025-10-30T15:12:34.000Z"
}'

Responses

🟢200
application/json
Any 2xx response is treated as success
Bodyapplication/json

Example
{
    "status": "success"
}
Previous
Get All Countries
Next
Error
Built with