Homepage

SmsNotification

Last edit: Jun 10, 2024

Sms Notification

type SmsNotification implements AdminSharedAttributesInterface {
  content: String
  created_at: JSONDate!
  delay_by: String
  form_configurations: [FormConfiguration!]
  forms: [Form!]
  id: ID!
  manually_managed: Boolean
  metadata: HashObject
  name: String!
  physical_file_path: String
  to: String!
  trigger_condition: String
  updated_at: JSONDate!
}

Fields

content (String)

liquid code to evaluate to valid text. If sms is triggered via form
configuration, You have access to "form" variable, with data specified in the configuration.

created_at (JSONDate)

delay_by (String)

liquid code which should evaluate to integer. Delays invoking the job by
specified number of minutes. Useful to invoke code at certain point in time,
for example 1 hour before something etc. To calculate proper number you can
use time_diff filter.

form_configurations (FormConfiguration)

form configurations which trigger the email

forms (Form)

forms which trigger the email

id (ID)

manually_managed (Boolean)

defines whether this objectwill be affected via pos-cli deploy / sync

metadata (HashObject)

name (String)

name of the sms, which is used in form_configurations or mutation to trigger it

physical_file_path (String)

defines the physical path of the file

to (String)

liquid code to evaluate to valid mobile number with country code, for example
+1 541 754 3010. Useful filter to build valid mobile number is
"$to_mobile_number".

trigger_condition (String)

liquid code which should evaluate to true if the sms should be sent

updated_at (JSONDate)

Interfaces

AdminSharedAttributesInterface

Questions?

We are always happy to help with any questions you may have.

contact us