Skip to main content
PUT
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

The hosts webhook steps may call on the federal plane.

hosts
string[]
required

Every host, replacing the list; empty, so no webhook step runs on the federal plane, by default. At most 50.

Maximum array length: 50

A host name such as hooks.example.com, or an IP address, without a scheme, port or path.

Maximum string length: 253
Pattern: ^(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?\.)*[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$|^[0-9A-Fa-f:.]+$

Response

AutomationSettingsResource

data
AutomationSettingsResource · object
required