v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Incoming Webhooks

Create an incoming webhook

Creates an incoming webhook for the authenticated account. Requires a USER API key and returns the access token needed to call the webhook.

post/public/v1/incoming-webhooks

Request body

namestring required

descriptionstring nullable

isActiveboolean

useAuthenticationboolean

Example request

{
  "name": "External CRM event",
  "description": "Receives events from the external CRM",
  "isActive": true,
  "useAuthentication": true
}

Response

Created incoming webhook

idstring required

namestring required

descriptionstring nullable

urlstring required

isActiveboolean required

useAuthenticationboolean required

createdAtstring required

updatedAtstring required

accessTokenstring nullable

Example response

{
  "id": "clx123incomingwebhook",
  "name": "External CRM event",
  "description": "Receives events from the external CRM",
  "url": "https://hooks.example.com/webhook/clx123incomingwebhook",
  "isActive": true,
  "useAuthentication": true,
  "createdAt": "2024-01-01T12:00:00Z",
  "updatedAt": "2024-01-01T12:00:00Z",
  "accessToken": "64-character-access-token"
}