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.

Path Parameters

connection
string
required

Body

application/json

Where a chat connection posts alerts and which ones, for the page and the API.

alert_on_sync_failed
boolean
required

Post when a sync run fails or finishes with failed records.

alert_on_needs_attention
boolean
required

Post when a connection needs someone to sign in again or reconnect it.

alert_channel
string | null

The channel's id at the vendor, such as Slack's C0123ABCD, from chat-channels. Null for none. Ignored by a vendor bound to one channel.

Maximum string length: 32
Pattern: ^[CG][A-Z0-9]{2,31}$
alert_channel_name
string | null

The channel's name as chat-channels gave it, shown beside it.

Maximum string length: 90

Response

ConnectionResource

data
ConnectionResource · object
required