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 REST hook subscription: where to send the event, and which.

target_url
string<uri>
required

Where to send the event: Zapier's target URL. HTTPS on the internet only.

Maximum string length: 2048
event
string
required

The webhook event, such as sales.order.confirmed.

Maximum string length: 100

Response

RestHookResource

data
RestHookResource · object
required