Subscribe Webhooks

POST

/Webhooks/Subscribe

Subscribe to the Events.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

{
    "Reference": "subscribe-webhook-001",
    "WebHooksList": [
        {
            "EventName": "SHIPMENT_CREATED",
            "URL": "www.test.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://partnerapi.flavorcloud.com/Webhooks/Subscribe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Reference": "subscribe-webhook-001",
    "WebHooksList": [
        {
            "EventName": "SHIPMENT_CREATED",
            "URL": "www.test.com"
        }
    ]
}'

Responses

🟢200Subscribe Webhooks Response

application/json

Body

Example

{
    "Reference": "string",
    "Status": "string",
    "Message": "string"
}

🟠401Authentication Error

🟠422Validation Error

🔴500Error Response

Modified at 2025-04-28 20:51:30

Get Landed Cost

Unsubscribe Webhooks