Search guides, API overviews and endpoints by name, path or keyword.

Communications

Usage guide for Communications in Admin: templates and examples, communication types and URL shortener.

Admin Last updated

Communications groups the Admin tools for preparing the communications sent to customers by email, SMS and WhatsApp. It has three sections in the side menu:

SectionWhat it is for
TemplatesBrowse, create, validate and send the templates of a tenant, and maintain the examples they are validated against.
TypesDefine the communication types and their arguments, and validate their templates across all tenants.
URL shortenerTurn a long URL into a short URL to use in a communication.

Concepts

  • Communication type: the reason for the communication, for example active_plan_info. It defines the arguments it receives and its delivery window. It is shared by all tenants.
  • Argument: a value filled in on each send, such as a phone number or a tariff. It has a type (String, Date, Number…) and can be sensitive.
  • Template: the text of a communication for a type, a channel and a language in a tenant. It includes the arguments as variables, for example [(${tariff})].
  • Channel: Email, SMS or WhatsApp.
  • Example: a test case for a template: some argument values and the expected output (sender, subject or content) the template must produce with them.
  • Validation: renders the template with the arguments of each example and compares the result with the expected output. A template can only be saved if all its examples pass.
  • Delivery window: when the communication can be delivered, for example ANYDAY_ANYTIME.