Skip to main content
POST
Create an integration hook

Authorizations

Authorization
string
header
required

Breakcold public API key, for example Bearer bc_live_....

Headers

X-Breakcold-Organization-Id
string

Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token.

Idempotency-Key
string

Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate.

Required string length: 1 - 200

Body

application/json
workspaceId
string
required
Minimum string length: 6
platform
enum<string>
required
Available options:
zapier,
make
targetUrl
string<uri>
required
eventType
enum<string>
required
Available options:
record.created,
record.updated,
record.deleted,
note.created,
note.updated,
note.deleted,
task.created,
task.completed,
relation.added,
relation.removed,
call.linked,
call.unlinked,
file.uploaded,
file.deleted
filterObjectTypeIds
string[]
Minimum string length: 6

Response

Success

hook
object
required