Add an alert channel

Adds a channel and subscribes it to the event kinds you list. The channel is created untested: nothing counts as working until a test send has reached the provider, so follow this with POST /{id}/test.

POST
/api/v1/alert-channels
AuthorizationBearer <token>

API key in the Authorization header: Authorization: Bearer wv_live_…. Keys are created on the API keys page in the app, shown once, and scoped to your workspace. X-Api-Key: wv_live_… is accepted as a fallback for tools that can't set Authorization.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "kind": "string",
  "name": "string",
  "enabled": true,
  "health": "untested",
  "credentialSet": true,
  "credentialSetAt": "2019-08-24T14:15:22Z",
  "connected": true,
  "destination": "string",
  "mutedUntil": "2019-08-24T14:15:22Z",
  "events": [
    {
      "kind": "string",
      "minSeverity": "info"
    }
  ],
  "lastSuccessAt": "2019-08-24T14:15:22Z",
  "lastFailureAt": "2019-08-24T14:15:22Z",
  "lastError": "string",
  "consecutiveFailures": 0,
  "createdAt": "2019-08-24T14:15:22Z"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "traceId": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "traceId": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "traceId": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "traceId": "string"
}

On this page