Skip to main content
POST
/
api
/
v1
/
webhooks
/
endpoints
Create Endpoint
curl --request POST \
  --url https://api.example.com/api/v1/webhooks/endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "filter_types": [
    "<string>"
  ],
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "<string>",
  "url": "<string>",
  "description": "<string>",
  "filter_types": [
    "<string>"
  ],
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
url
string
required

HTTPS URL where webhook payloads will be sent.

​
description
string | null

Human-readable label for this endpoint.

​
filter_types
string[] | null

Only deliver events of these types. Empty / None = all types.

​
user_id
string<uuid> | null

Subscribe only to events for this user. Empty / None = all users.

Response

Successful Response

​
id
string
required
​
url
string
required
​
description
string | null
​
filter_types
string[] | null
​
user_id
string<uuid> | null