Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

A webhook endpoint's URL and events, and when changing it, whether it is enabled.

url
string<uri>
required

An HTTPS URL on the internet. Private, loopback and link-local addresses are refused, after DNS too.

Maximum string length: 2048
events
string[]
required

The events to send, such as catalog.item.created.

Minimum array length: 1
Maximum string length: 100
enabled
boolean

Whether deliveries are sent. Only when changing an endpoint.

Response

WebhookSecretResource

data
WebhookSecretResource · object
required