Skip to main content
POST
Create Endpoint

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. Omit, or pass an empty list, to receive all event types.

user_id
string<uuid> | null

Subscribe only to events for this user. Omit, or pass null, to receive events for all users.

Response

Successful Response

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