Skip to content

Webhooks API

Manage webhook integrations for Slack, Teams, PagerDuty, and custom HTTP endpoints.

Required scope: webhooks:read or webhooks:write

Endpoints

GET/api/webhooksList webhooks
POST/api/webhooksCreate webhook
PUT/api/webhooks/:idUpdate webhook
DELETE/api/webhooks/:idDelete webhook
POST/api/webhooks/:id/testTest delivery
GET/api/webhooks/alert-typesAvailable alert types

Create Webhook

POST/api/webhooks

Request body:

json
{
  "name": "Slack Alerts",
  "url": "https://hooks.slack.com/services/...",
  "alert_types": ["monitor_down", "monitor_up", "test_failure"],
  "cooldown": 300,
  "enabled": true
}

Test Webhook

POST/api/webhooks/:id/test

Sends a test payload to the webhook URL and returns the delivery result.

Alert Types

GET/api/webhooks/alert-types

Returns the list of alert types that can trigger webhooks.

Released under the MIT License.