Skip to main content

AddNotificationRecipientInput

Input for creating a notification recipient.

input AddNotificationRecipientInput {
  appId: BigInt
  description: String
  meta: NotificationRecipientMetaInput
  name: String!
  organizationId: BigInt!
  recipientType: NotificationRecipientType!
  recipientValue: String!
}

Fields​

AddNotificationRecipientInput.appId ● BigInt scalar common​

The application ID used to scope access checks when creating the recipient.

AddNotificationRecipientInput.description ● String scalar common​

Notes describing the recipient.

AddNotificationRecipientInput.meta ● NotificationRecipientMetaInput input common​

Additional configuration for the recipient.

AddNotificationRecipientInput.name ● String! non-null scalar common​

The display name for the recipient.

AddNotificationRecipientInput.organizationId ● BigInt! non-null scalar common​

The organization that will own the recipient.

AddNotificationRecipientInput.recipientType ● NotificationRecipientType! non-null enum common​

The delivery channel to configure.

AddNotificationRecipientInput.recipientValue ● String! non-null scalar common​

The destination value, such as an email address or webhook URL.

Member Of​

addNotificationRecipient mutation