Skip to main content
WEBHOOK

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.

Headers

StockShift-Signature
string
required
Example:

"t=1760000000,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd"

Body

application/json
id
string
required

The same on every retry. Store it and skip events you have already handled.

type
string
required
Allowed value: "purchasing.order.sent"
created
string<date-time>
required
data
object
required

Response

2XX

Answer with any 2xx within 10 seconds. Anything else, or no answer in time, is retried with backoff for up to 24 hours.