Platform API ReferenceNotification Channels

Create an Alert Notification Channel

Create an Alert Notification Channel.

Path parameters

organizationIdstringRequired
The ID of the Organization to which the Notification Channel will belong.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The request body for creating a new Notification Channel.
CreateDagTriggerNotificationChannelRequestobjectRequired
OR
CreateEmailNotificationChannelRequestobjectRequired
OR
CreateOpsgenieNotificationChannelRequestobjectRequired
OR
CreatePagerDutyNotificationChannelRequestobjectRequired
OR
CreateSlackNotificationChannelRequestobjectRequired

Response

OK
createdAtstring

The time when the alert was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

createdByobject
definitionany
The notification channel's definition.
entityIdstring
The entity ID the notification channel is scoped to.
entityTypestring
The type of entity the notification channel is scoped to.
idstring
The notification channel's ID.
isSharedboolean
When entity type is scoped to ORGANIZATION or WORKSPACE, this determines if child entities can access this notification channel.
namestring
The notification channel's name.
organizationIdstring
The organization ID the notification channel is scoped to.
typestring
The notification channel's type.
updatedAtstring

The time when the alert was updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

updatedByobject
deploymentIdstring or null
The deployment ID the notification channel is scoped to.
entityNamestring or null
The name of the entity the notification channel is scoped to.
workspaceIdstring or null
The workspace ID the notification channel is scoped to.

Errors