Sign in

v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-22280107.9 KB
Webhooks

Create webhook endpoint

Register a new webhook endpoint. Maximum 5 endpoints per user.

post/webhooks/endpoints

Request body

urlstring uri required
descriptionstring
filter_typesstring[]

Event types to subscribe to. Empty array means all events.

Example request

{
  "url": "https://example.com/webhooks/yoshi",
  "description": "Production webhook handler"
}

Response

Endpoint created. The signing secret is returned once — store it securely.

Example response

{
  "meta": {
    "request_id": "req_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "timestamp": "2026-04-10T12:00:00.000Z"
  }
}