VoiceGateway

Set where an alert channel sends

PUT
/api/v1/org/{orgId}/project/{projectId}/alert-channels/{kind}

Authorization

consoleSession
cookievg_session<token>

The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.

Path Parameters

orgId*string

Authorised orgId; the server must verify organisation/project ownership before any read.

Length1 <= length
projectId*string

Authorised projectId; the server must verify organisation/project ownership before any read.

Length1 <= length
kind*string

A channel kind; any other value is not_found.

Value in"email""webhook""slack""teams""discord""pagerduty""opsgenie"

Request Body

application/json
  1. body
url?string

Webhook: the http or https URL each delivery is POSTed to (https only on Cloud). Slack, Teams, Discord: the provider's incoming webhook URL, https://hooks.slack.com/services/..., a Teams Workflows URL on logic.azure.com or api.powerplatform.com, or https://discord.com/api/webhooks/.... Sealed on the server and never returned.

Lengthlength <= 2048
rotateSecret?boolean

Webhook only: true makes a new signing secret, returned once.

recipients?array<>

Email only: 1 to 20 addresses that get every alert as one email.

Items1 <= items <= 20
key?string

PagerDuty: the Events API v2 integration (routing) key, 32 characters. Opsgenie: the API integration key. Sealed on the server and never returned.

Lengthlength <= 64
region?string

PagerDuty and Opsgenie only: the provider's service region, events.pagerduty.com or events.eu.pagerduty.com, api.opsgenie.com or api.eu.opsgenie.com.

Default"us"
Value in"us""eu"

Response Body

The channel as saved, with a new signing secret when one was made.

application/json
  1. response
kind*string

The channel kind.

Value in"email""webhook""slack""teams""discord""pagerduty""opsgenie"
target*string

What the channel sends to, safe to show: the host it posts to, or the recipient count.

recipients*array<string>|

The email channel's recipients.

signingSecret*|

The webhook's Standard Webhooks signing secret (whsec_...), returned only when it was made. Verify each delivery's webhook-signature with it.

Example Request
curl -X PUT 'https://example.com/api/v1/org/string/project/string/alert-channels/email' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "kind": "email",  "target": "string",  "recipients": [    "string"  ],  "signingSecret": "string"}

Was this page helpful?