Skip to main content
POST
/
v1
/
retailers
/
{retailer_id}
/
webhooks
Subscribe to webhooks
curl --request POST \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/webhooks/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 11011,
  "url": "https://webhook.example.com/notify",
  "event": "order.created",
  "is_active": true
}
'
{
  "id": 11011,
  "url": "https://webhook.example.com/notify",
  "event": "order.created",
  "is_active": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
retailer_id
integer
required

The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.

Example:

1001

Body

application/json

Webhook subscription payload

​
id
integer

Unique identifier for the subscription

Example:

11011

​
url
string<uri>

Webhook listener endpoint

Example:

"https://webhook.example.com/notify"

​
event
string

The event to subscribe to (e.g., order.created)

Example:

"order.created"

​
is_active
boolean

Whether the subscription is currently active

Example:

true

Response

201 - application/json

Webhook subscription created

Webhook subscription payload

​
id
integer

Unique identifier for the subscription

Example:

11011

​
url
string<uri>

Webhook listener endpoint

Example:

"https://webhook.example.com/notify"

​
event
string

The event to subscribe to (e.g., order.created)

Example:

"order.created"

​
is_active
boolean

Whether the subscription is currently active

Example:

true