v1

latestOpenAPI 3.0.02026-07-26117198177.4 KB
Channels

Add, update, or remove alert channels

Batch create, update, or soft-delete alert channels for your workspace. Each operation specifies an action ("add", "update", or "remove") and the channel data.

put/v1/risk/channels

Request body

Example request

{
  "operations": [
    {
      "action": "add",
      "channel": {
        "name": "Primary Slack Channel",
        "type": "slack",
        "params": {
          "webhook_url": "https://hooks.slack.com/services/T00/B00/xxxx"
        }
      }
    },
    {
      "action": "update",
      "channel": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Renamed Channel",
        "enabled": false
      }
    },
    {
      "action": "remove",
      "channel": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    }
  ]
}

Response

acknowledgedboolean required

Example response

{
  "acknowledged": true
}