post

/webhooks

Creates and returns a new webhook. NOTE: The Content-Type header for this request should be set to application/x-www-form-urlencoded.

Authorization

apiKey - Authorization

Request Body

Form data (application/x-www-form-urlencoded)
data
string

The value of this field should be set as a string representing a JSON payload like: {"url":"http://123456.ngrok.io","active":true,"type":"product.update"}

required

Responses

1 Example
Schema
object

Webhook object

id
string

Auto-generated object ID.

1 validation + required
retailer_id
string

The ID of the retailer which the webhook request originated from.

1 validation + required
active
boolean

Indicates whether the webhook is active.

required
type
string

Webhook type. One of: product.update, inventory.update, sale.update, customer.update, consignment.receive, register_closure.create.

required
url
string

The URL of the endpoint prepared for receiving webhooks.

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
domain_prefix
$$.env
1 variable not set
Authorization