Skip to main content
ZStack
Alerting & Response/Alert Channels & Integrations

CreateAlertChannel

Create a new notification channel for alert delivery

POST/api/v1/alerting/channels

Operation ID

CreateAlertChannel

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • name
    StringRequired

    Human-readable channel name

    Example: Ops Email Channel

  • description
    StringRequired

    Description of the channel purpose

    Example: Email notifications for operations team

  • type
    StringRequired

    Channel type: email, webhook, dingtalk, etc.

    Example: email

  • config
    ObjectRequired

    Channel-specific configuration. Supply real credential values; the redaction placeholder *** is only valid when updating an existing channel.

    Example: (nested object)

  • templateId
    StringRequired

    Message template identifier for rendering

    Example: tmpl-email-001

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Unique identifier of the channel

    Example: chan-001

  • name
    String

    Human-readable channel name

    Example: Ops Email Channel

  • description
    String

    Description of the channel purpose

    Example: Email notifications for operations team

  • type
    String

    Channel type: email, webhook, dingtalk, etc.

    Example: email

  • status
    String

    Channel status: active or disabled

    Example: active

  • config
    Object

    Channel-specific configuration (varies by type). Stored credentials are returned as the redaction placeholder ***.

    Example: (nested object)

  • templateId
    String

    Message template identifier for rendering

    Example: tmpl-email-001

  • alertCount
    String

    Number of alerts sent through this channel

    Example: 150

  • createDate
    String

    Timestamp when the channel was created

    Example: 2026-01-15T08:00:00Z

  • lastOpDate
    String

    Timestamp of the last channel modification

    Example: 2026-01-15T08:00:00Z