1. Webhook
Flype Order API Gulf
  • UAE API Integration Guide
    • Shipments
      • Shipments Count
      • All Shipments
      • Bulk Order
      • 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
  1. Webhook

Shipment Status Updates Webhook

POST
/flype/webhook/shipment-status

Webhook - Shipment status updates#

Use this webhook to receive near real-time shipment status updates from Flype shipments.
Flype will send a POST request to your configured webhook URL whenever a shipment status changes.
Your server should accept requests with Content-Type: application/json.

Webhook URL#

The webhook URL is hosted on your server and should be shared with Flype for configuration.
  • Base URI: Your server base path, for example https://api.example.com
  • Request URI: Your webhook path, for example /flype/webhook/shipment-status
  • Full URL example: https://api.example.com/flype/webhook/shipment-status

When this webhook is triggered#

  • When a shipment status changes.
  • When a shipment moves through pickup, transit, delivery, cancellation, delay, or return stages.
  • When Flype needs to notify your system about the latest shipment progress.

Expected behavior from your server#

  • Your server should respond quickly after receiving the webhook.
  • Your server should return a successful response after the payload is received and accepted.
  • Your system should use the tracking number and status fields in the payload to update the related shipment record.
  • Your endpoint should be idempotent, meaning repeated webhook events should not create duplicate or incorrect shipment updates.

Important notes#

  • This is not an endpoint hosted by Flype. It is an endpoint hosted by your system.
  • Flype sends shipment status updates to this URL.
  • The webhook method is POST.
  • The request body format is application/json.
  • The exact webhook URL must be provided to Flype before status updates can be sent.

Summary#

Use this webhook to keep your system updated with the latest shipment status changes from Flype 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 --request POST '/flype/webhook/shipment-status' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "trackingNumber": "F78ECYH0BNZ8",
    "status": "delivered",
    "orderDate": "2025-10-30T15:12:34.000Z"
}'

Responses

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

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