Skip to main content

NotificationTemplate

A notification template. When a notifiable event happens, this template will be used to send out notifications about it.

type NotificationTemplate {
  body_html: String
  body_sms: String
  body_text: String
  event_key: NotificationEventKey!
  id: ID!
  notification_destinations: [NotificationDestination!]!
  subject: String
}

Fields​

NotificationTemplate.body_html ● String scalar​

A Liquid template containing the email body for this notification in HTML.

NotificationTemplate.body_sms ● String scalar​

A Liquid template containing the SMS body for this notification.

NotificationTemplate.body_text ● String scalar​

A Liquid template containing the email body for this notification in plain text.

NotificationTemplate.event_key ● NotificationEventKey! non-null enum​

The event key that this notification template is sent for.

NotificationTemplate.id ● ID! non-null scalar​

The ID of the notification template

NotificationTemplate.notification_destinations ● [NotificationDestination!]! non-null object​

The destinations that this notification will be sent to.

NotificationTemplate.subject ● String scalar​

The email subject for this notification.

Member Of​

Convention object ● UpdateNotificationTemplatePayload object