Notification Providers

Create a new Webhook notification provider

Webhook providers send notifications as JSON payloads to any HTTP endpoint. You can configure custom headers for authentication (Bearer tokens, API keys, etc.). The webhook will receive a JSON payload with notification details including: id, title, message, type, priority, severity, timestamp, and metadata.

post/notification-providers/webhook

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/notification-providers/webhook
  • Auth: HTTP bearer

Request body

enabledboolean nullable
namestring required

Example request

{
  "config": {
    "headers": {
      "Authorization": "Bearer your-token",
      "X-Custom-Header": "custom-value"
    },
    "method": "POST",
    "timeout_secs": 30,
    "url": "https://api.example.com/notifications"
  }
}

Response

Successfully created Webhook provider

configunknown required
created_atinteger required
enabledboolean required
idinteger required
namestring required
provider_typestring required
updated_atinteger required

Changes

No recorded changes to this operation across all 53 revisions of this API.