Template

A template is represented in YAML as a normal string, and thus supports all of YAML's string syntaxes. Templates receive post-processing that injects dynamic values into the string. A templated value is represented with {{...}}.

Templates can generally be used in any value in a request recipe (not in keys), as well as in profile values and chains. This makes them very powerful, because you can compose templates with complex transformations.

For more detail on usage and examples, see the user guide page on templates.

Template Sources

There are several ways of sourcing templating values:

Source	Syntax	Description	Default
Profile Field	`{{field_name}}`	Static value from a profile	Error if unknown
Environment Variable	`{{env.VARIABLE}}`	Environment variable from parent shell/process	`""`
Chain	`{{chains.chain_id}}`	Complex chained value	Error if unknown

Escape Sequences

In some scenarios you may want to use the {{ sequence to represent those literal characters, rather than the start of a template key. To achieve this, you can escape the sequence with an underscore inside it, e.g. {_{. If you want the literal string {_{, then add an extra underscore: {__{.

Template	Parses as
`{_{this is raw text}}`	`["{{this is raw text}}"]`
`{_{{field1}}`	`["{", field("field1")]`
`{__{{field1}}`	`["{__", field("field1")]`
`{_`	`["{_"]` (no escaping)

Examples

# Profile value
"hello, {{location}}"
---
# Multiple dynamic values
"{{greeting}}, {{location}}"
---
# Environment variable
"hello, {{env.LOCATION}}"
---
# Chained value
"hello, {{chains.where_am_i}}"
---
# No dynamic values
"hello, world!"
---
# Escaped template key
"{_{this is raw text}}"