Subscribe to webhooks

Subscribe to events via webhooks for a retailer.

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

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

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