SmsNotificationInputType

Attributes of an SMS notification, the same ones that can be set in a smses/*.liquid file

type SmsNotificationInputType {
  content: String
  delay_by: String
  form_configuration_ids: [ID]
  form_ids: [ID]
  metadata: HashObject
  name: String
  physical_file_path: String!
  to: String
  trigger_condition: String
}

Fields

content (String)

Liquid code rendered into the text of the message. The data argument of sms_send is available in the data variable

delay_by (String)

Number of minutes sms_send waits before sending the SMS, given as a plain
number, for example 60. Defaults to 0, sent right away

form_configuration_ids (ID)

Deprecated, ignored. Ids of legacy forms

form_ids (ID)

Deprecated, ids of legacy forms that send the SMS; replaces the current list

metadata (HashObject)

Arbitrary JSON data stored with the SMS (the metadata section of the file)

name (String)

Deprecated, the name is derived from physical_file_path. Name used to send the SMS with the sms_send mutation

physical_file_path (String)

Path of the file the SMS is stored as, used by pos-cli pull and deploy. Must
be smses/<name>.liquid (or legacy
notifications/sms_notifications/<name>.liquid), optionally prefixed with
modules/<module_name>/public/ or modules/<module_name>/private/, for
example smses/welcome.liquid

to (String)

Liquid code rendering to the recipient mobile number with country code, for
example +15417543010; the to_mobile_number filter helps build it. Required

trigger_condition (String)

Liquid code; the SMS is sent only when it renders to true. Defaults to true