Skip to main content

notificationCreate

Creates an enabled notification rule that sends action events for a goal, survey, or site to a channel, and returns it. Uses channelId when given, otherwise reuses or creates an email or API channel for channelDestination; a rule duplicating an existing channel, resource, and action fails. Requires notifications edit access.

notificationCreate(
  resource: NotificationResource!
  resourceId: String!
  action: NotificationAction!
  channelType: ChannelInputType!
  channelId: Int
  channelDestination: String
): Notification!

Arguments

`notificationCreate.resource` ● `NotificationResource!` non-null enum

Resource to watch: a goal, survey, or site for error notifications.

`notificationCreate.resourceId` ● `String!` non-null scalar

Resource id as a string from goalCardList, addonList, or sites according to resource.

`notificationCreate.action` ● `NotificationAction!` non-null enum

Event to notify on: CONVERTED for goals, RESPONDED/COMPLETED for surveys, ERROR_OCCURRED for sites.

`notificationCreate.channelType` ● `ChannelInputType!` non-null enum

Channel type for a new destination; SLACK requires an existing channelId.

`notificationCreate.channelId` ● `Int` scalar

Existing id from channelsList for the same site; takes precedence over channelDestination.

`notificationCreate.channelDestination` ● `String` scalar

Email address or API URL when channelId is omitted; matching channels are reused.

Type

`Notification` object

Notification delivery rule returned by notificationsList, notificationCreate, and notificationEdit.

Arguments
Type