Skip to main content
POST
Create a new webhook endpoint

Authorizations

X-Api-Key
string
header
required

Body

application/json
name
string
required

Display name for the endpoint (does not filter events)

url
string<uri>
required

HTTPS URL that will receive webhook POST requests

Response

Webhook endpoint created

data
object

The wire contract for a webhook endpoint, AT THE LATEST VERSION.

This is the single source of truth: toWebhookEndpointResponse is annotated to return it (so the code cannot drift from it without a compile error), and the OpenAPI spec + docs + breaking-change gate are all generated from it.

_id is the stringified identifier. All fields are primitive strings; there are no nested relations or date values on this shape.

success
boolean
Example:

true