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": [],
  "description": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "subscribedEvents": [
      "<string>"
    ],
    "enabled": true,
    "consecutiveFailures": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "disabledReason": "<string>",
    "disabledAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.devhelm.io/llms.txt

Use this file to discover all available pages before exploring further.

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
enum<string>[]
required

Event types to deliver

Minimum array length: 1
Available options:
monitor.created,
monitor.updated,
monitor.deleted,
incident.created,
incident.resolved,
incident.reopened,
service.status_changed,
service.component_changed,
service.incident_created,
service.incident_updated,
service.incident_resolved
Minimum string length: 1
​
description
string | null

Optional human-readable description

Maximum string length: 255

Response

Created

​
data
object
required

Webhook endpoint that receives event delivery payloads