Message types schema reference

A message type schema defines the fields that a message type will have in the template editor and forms the structure of the message contents returned by the guides API.

An example schema is shown below:

Your schema must have one or more variants. Each of these variants must have:

• A key uniquely identifying the variant for the message type
• A name to display in the message template editor to select the variant
• One or more fields (see below)

Every schema must define a variant with the key "default". You can name your variants anything you would like, but the variant key must be unique.

All fields must have:

• type: The type of the field to render (see below)
• key: A unique key for the field in the variant
• label: A label to render

A plain text, single line text field.

Example

A markdown editor for creating rich text. Will always be rendered as HTML.

A multi-line plain text area

A checkbox that returns either true or false (checked or unchecked).

A single select box that defines a static list of options for editors to pick from.

In your template preview, you can access the value of the selected option using the field's key. For example:

A multi-select box that defines a static list of options for editors to pick from.

In your template preview, you can access the selected values using the field's key. For example:

A button, with text to display and an action to perform when clicked.

Every button field contains two subfields:

An image field, used to display an image with alt text and an optional action to perform when clicked.

Every image field contains three subfields: