Homepage

SmsNotificationInputType

Last edit: Oct 26, 2022

No description

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 to evaluate to valid form html. If sms is triggered via form
configuration, You have access to "form" variable, with data specified in configuration.

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_configuration_ids (ID)

deprecated, use form_ids

form_ids (ID)

ids of forms which should trigger the sms

metadata (HashObject)

name (String)

deprecated - derived from physical_file_path;name of the sms, which is used in forms or mutation to trigger it

physical_file_path (String)

defines where the file definition will be available after pull; should start
with the module name follow by private/public scope, for example
manual/public/smses/my_sms_notification

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

Contribute to this page More info

Github Icon

Questions?

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

contact us