Create an Alert Notification Channel

Create an Alert Notification Channel.

organizationIdstringRequired

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

This endpoint expects an object.

Create Dag Trigger Notification Channel RequestobjectRequired

Create Email Notification Channel RequestobjectRequired

Create Opsgenie Notification Channel RequestobjectRequired

Create Slack Notification Channel RequestobjectRequired

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.

1	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/notification-channels \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"definition": {
6	"dagId": "dagId",
7	"deploymentApiToken": "deploymentApiToken",
8	"deploymentId": "deploymentId"
9	},
10	"entityId": "entityId",
11	"entityType": "ORGANIZATION",
12	"isShared": false,
13	"name": "name",
14	"type": "SLACK"
15	}'

1	{
2	"createdAt": "createdAt",
3	"createdBy": {
4	"apiTokenName": "my-token",
5	"avatarUrl": "https://avatar.url",
6	"fullName": "Jane Doe",
7	"id": "clm8qv74h000008mlf08scq7k",
8	"subjectType": "USER",
9	"username": "user1@company.com"
10	},
11	"deploymentId": "deploymentId",
12	"entityId": "entityId",
13	"entityName": "entityName",
14	"entityType": "entityType",
15	"id": "id",
16	"isShared": false,
17	"name": "name",
18	"organizationId": "organizationId",
19	"type": "type",
20	"updatedAt": "updatedAt",
21	"updatedBy": {
22	"apiTokenName": "my-token",
23	"avatarUrl": "https://avatar.url",
24	"fullName": "Jane Doe",
25	"id": "clm8qv74h000008mlf08scq7k",
26	"subjectType": "USER",
27	"username": "user1@company.com"
28	},
29	"workspaceId": "workspaceId"
30	}