Register a webhook endpoint

POST/v1/webhooks

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

Public HTTPS endpoint. Private/internal addresses are rejected, and redirects are refused at delivery time.

Formaturi

Lengthlength <= 2000

events?array<|>

Default["*"]

Items1 <= items <= 20

description?string

Lengthlength <= 500

Response Body

`application/json`

cURL

curl -X POST "https://example.com/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com"  }'

{
  "success": true,
  "endpoint": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "url": "string",
    "events": [
      "string"
    ],
    "enabled": true,
    "description": "string",
    "secret": "string",
    "consecutiveFailures": -9007199254740991,
    "lastDeliveryAt": "2019-08-24T14:15:22Z",
    "lastDeliveryStatus": -9007199254740991,
    "lastError": "string",
    "disabledAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

{
  "success": false,
  "error": "API key lacks write permission"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`