Add a notification channel

POST

/notifications/channels

curl --request POST \
  --url https://api.krakenkey.io/notifications/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "type": "slack", "name": "Ops alerts", "url": "https://hooks.slack.com/services/T000/B000/XXXX", "events": [ "cert.issued" ], "enabled": true }'

For webhook channels the response includes the signing secret. It is shown only once.

Authorizations

• bearer

Request Body^required

Media typeapplication/json

object

type

required

string

Allowed values: slack teams webhook

Example

slack

name

required

string

<= 100 characters

Example

Ops alerts

url

required

Destination URL. Slack: an incoming webhook (https://hooks.slack.com/services/…). Teams: a Workflows webhook URL (Office 365 connectors are retired). Webhook: any https URL that resolves only to public addresses. Stored encrypted and never returned in full.

string

Example

https://hooks.slack.com/services/T000/B000/XXXX

events

Events to send. Defaults to cert.failed, cert.expiring, cert.revoked, cert.replacement_requested, domain.verification_failed, endpoint.scan_failed, deploy.failed, connector.stale.

Array<string>

Allowed values: cert.issued cert.renewed cert.failed cert.expiring cert.revoked cert.replacement_requested domain.verification_failed endpoint.scan_failed deploy.failed connector.stale

enabled

boolean

default: true

Responses

201

Channel created

400

Invalid URL, unknown event or channel limit reached