Skip to content

Add a notification channel

Add an email, webhook, Slack, Discord or Telegram channel.

Updated

post

https://cloud.cahaves.com/api/notification-channels

Authorization

cahaves.cloud.sessionstringcookierequired

The session cookie Cloud sets when a customer signs in to the console with GitHub or Google. It is HttpOnly, so scripts cannot read it, and there are no API keys or tokens yet.

Headers

X-Cloud-Organizationstring<uuid>

The id of the organization the request works in, one the signed-in customer owns. Left out or empty, the request works in their oldest organization. Any other value answers 404 with `reason: "organization"`. A customer with no organization yet gets 409 "Create an organization first." from every route that works in one.

Example: "2f6c8e0a-4b1d-4e7f-9a3c-5d7e9f1b3a5c"

Body

application/jsonrequired

kindstringrequired

Allowed values: "email""webhook""slack""discord""telegram"

namestringrequired

configobjectrequired

The shape follows the channel's kind.

eventsstring[]required

enabledboolean

Default: true

Responses

application/json

The channel.

notification_channelobjectrequired

The shape of config follows kind. Notifications describes the webhook body and how to check its signature.

A fault answers 422 with the model's own message for the field, so a configuration fault reads with the prefix Config, as in "Config Use a Slack incoming webhook URL.", and names config. Strip the prefix before showing it.