Skip to main content
POST
Create a new webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Webhook name

Required string length: 3 - 50
Example:

"Production Deployment Hook"

url
string<uri>
required

Webhook URL endpoint

Example:

"https://api.example.com/webhooks/onset"

events
object
required

Webhook event subscriptions

Example:

Response

Webhook created successfully

id
string

Unique webhook identifier

name
string

Webhook name

url
string<uri>

Webhook URL endpoint

events
object

Webhook event subscriptions

Example:
last_triggered_at
string<date-time> | null

When the webhook was last triggered

created_at
string<date-time>

When the webhook was created

updated_at
string<date-time>

When the webhook was last updated