Skip to main content
POST
/
api
/
v1
/
webhooks
Register a new webhook endpoint
curl --request POST \
  --url https://api.devhelm.io/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "subscribedEvents": [
    "<string>"
  ],
  "description": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "description": "<string>",
    "subscribedEvents": [
      "<string>"
    ],
    "enabled": true,
    "consecutiveFailures": 123,
    "disabledReason": "<string>",
    "disabledAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Body

application/json
​
url
string
required

HTTPS endpoint that receives webhook event payloads

Maximum string length: 2048
​
subscribedEvents
string[]
required

Event types to deliver, e.g. monitor.created, incident.resolved

Minimum array length: 1

Event types to deliver, e.g. monitor.created, incident.resolved

Minimum string length: 1
​
description
string

Optional human-readable description

Maximum string length: 255

Response

201 - */*

Created

​
data
object

Webhook endpoint that receives event delivery payloads