Create an Alert Notification Channel | Astronomer Documentation

curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/notification-channels \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "definition": {
    "dagId": "dagId",
    "deploymentApiToken": "deploymentApiToken",
    "deploymentId": "deploymentId"
  },
  "entityId": "entityId",
  "entityType": "ORGANIZATION",
  "name": "name",
  "type": "SLACK"
}'

{
  "createdAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "definition": {
    "key": "value"
  },
  "entityId": "entityId",
  "entityType": "entityType",
  "id": "id",
  "isShared": true,
  "name": "name",
  "organizationId": "organizationId",
  "type": "type",
  "updatedAt": "2022-11-22T04:37:12Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "deploymentId": "deploymentId",
  "entityName": "entityName",
  "workspaceId": "workspaceId"
}

Create an Alert Notification Channel.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

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

Request

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

Response

createdAtdatetime

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

createdByobject

definitionany

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.

updatedAtdatetime

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

updatedByobject

deploymentIdstring

The deployment ID the notification channel is scoped to.

entityNamestring

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

workspaceIdstring

The workspace ID the notification channel is scoped to.

Errors

400

Create Notification Channel Body Bad Request Error

401

Create Notification Channel Body Unauthorized Error

403

Create Notification Channel Body Forbidden Error

404

Create Notification Channel Body Not Found Error

500

Create Notification Channel Body Internal Server Error