Application Message Templates

Application channels support message templates that are synced from the external services they connect to. You sync the templates using the Channel API. While the templates are originally created in the external service, they can include variables that get replaced with dynamic values from Front when sent.

To learn more about these templates, refer to Application Channel Message Templates.

Example structure

{
  "external_id": "123456789",
  "name": "order_update",
  "blurb": "Hello {{1}}, your order …",
  "is_disabled": false,
  "status_name": "APPROVED",
  "variable_mappings": [
    {
      "uid": "test_uid",
      "type": "text",
      "name": "BODY_1"
    }
  ],
  "template_preview": "<div style="background-color: red; color: white; padding: 10px;">Message template preview</div>"
}
FieldTypeDescription
external_idStringExternal identifier for the template, used to reference it in external systems.
nameStringHuman-readable name of the template.
blurbStringShort representation of the template for preview purposes in Front.
is_disabledBooleanIndicates whether the template is disabled (true) or active (false) for use in the external system.
status_nameStringProvides a reason for why the template is disabled or enabled in the external system. One of "PENDING", "APPROVED", or "REJECTED".
variable_mappingsArray of ObjectsList of variable mappings. Each mapping defines how template variables are linked or transformed.
variable_mappings.uidStringUnique identifier for the variable mapping. Must be mapped back to the variable’s position in the template.
variable_mappings.typeStringType of the variable (text, file, image, video).
variable_mappings.nameStringHuman-readable label for the variable.
template_previewStringHTML preview representation of the template, used by Front to display its content. In-line styling is required.