Skip to main content
POST
Create a channel

Authorizations

Authorization
string
header
required

Use Authorization: Bearer

Body

application/json
name
string
required

Display name for the channel.

Required string length: 1 - 255
Example:

"My Slack Channel"

type
enum<string>
required

Channel delivery type.

Available options:
slack,
telegram,
discord,
webhook,
pagerduty,
email,
incidentio
Example:

"slack"

params
object

Type-specific parameters. Slack, Discord, and generic webhooks require webhook_url. PagerDuty requires routing_key. Email requires recipients (array of addresses). incident.io requires url and token. Telegram is generated server-side.

Example:

Response

200 - application/json
id
string
required
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

workspace_id
string
required
Example:

"workspace-123"

name
string
required
Example:

"My Slack Channel"

type
enum<string>
required
Available options:
slack,
telegram,
discord,
webhook,
pagerduty,
email,
incidentio
Example:

"slack"

enabled
boolean
required
Example:

true

connected
boolean
required

Whether the channel is ready to receive deliveries. Always true except for a telegram channel that has not yet linked a chat.

Example:

true

created_at
string
required
Example:

"2026-05-14T12:00:00.000Z"

updated_at
string
required
Example:

"2026-05-14T12:00:00.000Z"

params
object

Type-specific channel parameters.

Example:
deleted_at
string | null

Soft-delete timestamp. Null while the channel is active.

Example:

null

Last modified on July 1, 2026