Webhook: Shipment status updates (Flype → Your Server)

POST

/flype/webhook/shipment-status

Webhook — Shipment status updates (Flype → Your API)

Flype will send real-time shipment status updates to your webhook URL.

✅ Action required: You must provide this webhook URL to Flype so we can call your API whenever a delivery status changes.

How it works

Flype makes a POST request to your webhook endpoint (the URL you provide).

Your server should return any 2xx response to acknowledge receipt.

Use the payload to update the shipment status in your system.

Headers

Content-Type: application/json

Security (recommended)

Protect the webhook using a shared secret (e.g., X-Webhook-Signature or X-Webhook-Token) so only Flype can call it.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Acknowledgement

Body

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"
}'

Response Example

{
    "status": true
}

Get Shipping label

ApiStatus

Webhook: Shipment status updates (Flype → Your Server)

Webhook — Shipment status updates (Flype → Your API)#

Request

Responses

Webhook — Shipment status updates (Flype → Your API)