Skip to main content
POST
/
api
/
v1
/
webhooks
Create Webhook
curl --request POST \
  --url https://api.example.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>"
}
'
{
  "id": 123,
  "user_id": "<string>",
  "url": "<string>",
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

​
Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

​
Required Permissions

Webhooks:Create: Always required.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Schema for creating a webhook.

​
url
string
required

Response

Successful Response

Schema for webhook response.

​
id
integer
required
​
user_id
string
required
​
url
string
required
​
is_active
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time> | null