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

This endpoint expects an object.
Create Dag Trigger Notification Channel RequestobjectRequired
OR
Create Email Notification Channel RequestobjectRequired
OR
Create Opsgenie Notification Channel RequestobjectRequired
OR
Create Pager Duty Notification Channel RequestobjectRequired
OR
Create Slack Notification Channel RequestobjectRequired

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
deploymentIdstringOptional

The deployment ID the notification channel is scoped to.

entityNamestringOptional

The name of the entity the notification channel is scoped to.

workspaceIdstringOptional

The workspace ID the notification channel is scoped to.

Errors