Skip to content

Create a webhook

POST
/v1/webhooks
curl --request POST \
--url https://example.com/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "url": "example", "active": true, "events": [ "example" ], "secret": "example" }'

Subscribes an endpoint to one or more events (for example response.created). Deliveries are HMAC-signed, batched and retried.

object
name
required
string
>= 1 characters <= 255 characters
url
required
string
>= 1 characters <= 2048 characters
active
boolean
events
required
Array<string>
>= 1 items
secret
string
nullable
Example generated
{
"name": "example",
"url": "example",
"active": true,
"events": [
"example"
],
"secret": "example"
}

OK