Skip to main content
POST
Create a webhook endpoint

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required
Required string length: 1 - 255
url
string<uri>
required
Pattern: ^https://
event_types
enum<string>[]
required
Minimum array length: 1
Available options:
alerts.triggered,
alerts.resolved
headers
object
timeout_ms
integer
default:5000
Required range: 1000 <= x <= 30000
enabled
boolean
default:true

Response

Webhook endpoint created successfully.

id
string
required
Pattern: ^whe_[A-Za-z0-9]+$
Example:

"whe_9ZtRcXw3nByK5pVqMaEfJs"

name
string
required
Required string length: 1 - 255
url
string<uri>
required
enabled
boolean
default:true
required
event_types
enum<string>[]
required
Available options:
alerts.triggered,
alerts.resolved
timeout_ms
integer
default:5000
required
Required range: 1000 <= x <= 30000
created_at
string<date-time>
required
updated_at
string<date-time>
required
signing_secret
string
required

Returned only once during endpoint creation. Store it securely.

headers
object
Last modified on March 19, 2026