Create a webhook endpoint

Regionalus.api.brault.app— follows the region selector in the top bar

The response carries the signing secret. It is shown here and once more on roll-secret, and can never be read back. Sending an Idempotency-Key caches this response — the secret included — for 24 h; omit the header if you do not want that.

Authorization

apiKey

AuthorizationBearer <token>

API key from Settings → Developers

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

Lengthlength <= 2048

name?string

Empty or whitespace-only is stored as null.

Lengthlength <= 60

events*array<string>

Catalogue tokens from GET /v1/events, or the single element "*".

Items1 <= items <= 58

Response Body

`application/json`

curl -X POST "https://example.com/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "https://example.com/hooks/brault",    "events": [      "string"    ]  }'

{  "object": "webhook",  "id": "string",  "url": "string",  "name": "string",  "events": [    "string"  ],  "status": "active",  "disabled_reason": "string",  "secret": "string",  "secret_last4": "string",  "secret_rolled_at": "2019-08-24T14:15:22Z",  "consecutive_failures": 0,  "last_delivery_at": "2019-08-24T14:15:22Z",  "last_success_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "created_by_id": "string"}

Authorization

Request Body

Response Body

201application/json

defaultapplication/json

`application/json`

`application/json`