FlavorCloud Partner API Documentation

Subscribe Webhooks

POST

/Webhooks/Subscribe

Webhooks

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

Reference

string

optional

This field is for your reference. A good use of it would be to provide your order number or store name here.

>= 1 characters<= 30 characters

WebHooksList

array[object (WebHookInfo) {2}]

required

EventName

enum<string>

required

You can subscribe to one or more of the following events

Allowed values:

SHIPMENT_CREATEDSHIPMENT_COMPLETEDSHIPMENT_CANCELLEDSHIPMENT_CANCELLATION_ERRORSHIPMENT_ERRORRETURN_SHIPMENT_CREATEDRETURN_SHIPMENT_ERRORRETURN_SHIPMENT_CANCELLEDTRACKING_UPDATESORDER_PLACEDCONSOLIDATE_SHIPMENT_CREATEDCONSOLIDATE_SHIPMENT_ERROR

Default:

URL

string

required

This is the url that will be called when the subscribed event is triggered

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

Reference

string

required

This field is for your reference. A good use of it would be to provide your order number or store name here.

Status

string

required

Your FlavorCloud application id

Message

string

required

Your rest api key

Example

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

🟠401Authentication Error

🟠422Validation Error

🔴500Error Response

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

Get Manifest

Unsubscribe Webhooks