Template parameters allow you to define visual parameters in your code. These parameters can then be modified on a separate page by non-technical users using simple inputs. Using parameters allows you to create advanced templates for [Weblayers](🔗), [Experiments](🔗), [Tag manager](🔗), and [Webhooks](🔗).

Template parameters vs. Jinja

Template parameters are different than Jinja. While template parameters are about defining visual parameters in the code, Jinja allows you to insert personalization. [Read more about Jinja here](🔗).

# Where to use template parameters

Template parameters can be used in the following places:

  • [Weblayers](🔗) and Weblayer templates

  • [Experiments](🔗)

  • [Tag manager](🔗) and Tag templates

  • Webhooks and Webhook templates

New HTML Blocks

We have implemented new HTML Blocks, and old HTML Blocks will be slowly discontinued in line with our [Migration plan](🔗).

Learn how to use parameters with new HTML blocks in our [guide](🔗)!

# Basic Syntax

The most basic template parameter looks like this:

Here is what the user sees in the application:


As you can see, you can define multiple parameters and create a template that is easy to use, even for non-technical people. For example, this is a simple Tag template using three simple template parameters:


# Specifying Parameter Type

You can specify the type of the parameter like this:

Where `type` is one of these:

  • `string` (default) – a simple one-line text

  • `text` – multi-line text

  • `number` – accepts only a number

  • `color` – accepts only color values in HEX form and shows a color picker

  • `enum` – allows the user to select from a set of predefined values

  • `recommendation` – allows the user to select a recommendation from the project

  • `metric` – allows the user to select a metric from the project

  • `date` – date picker

  • `time` – time picker

  • `datetime` – date and time picker which allows selecting a timestamp

  • `boolean` – accepts a true/false value

  • `image` – input with `+` button to access the file manager, accepts a file URL

## Using the Enum Type

If you want to use the `enum` type, you have to use the following syntax:

You can provide any number of values you like. The user will see a select box with those values and be will allowed to choose from them.



Using these types allows us to create better templates. You can improve the previous Tag template as in this example:


## Whitespace

Whitespace is not essential and is ignored. You can use it however you like. The only whitespace which matters is in the parameter name and enum values. For example, all these are valid:

# Default Values

You can specify a default value for a template parameter using this syntax:

For example, in the template above, you could set the default request method like this:

# Recommendations and Metrics

Using the `recommendation` and `metric` types allows users to select a recommendation or a metric from the current project. They will see a nice select box, and you will get the ID of the picked item in your code.


# Special Characters

You can use special characters in the parameter name as well as in the default value and the enum options. For example, these are valid parameter definitions:

# Advanced parameters

A slightly more complex syntax has been introduced, allowing a better organization of parameters supporting functionalities like ordering and spring. This allows you to group parameters into collapsible categories with tooltips.

Advanced parameters use a **JSON notation** to define a parameter. Using parameters in JSON is possible when you add `isJsonParam = true` at the end of the parameter name.

The type and the default value work exactly the same as in the basic syntax - : string | param default value.

As opposed to the simple syntax, you can define additional attributes using a JSON syntax:

  • `name` - specify the name of the parameter

  • `tooltip` - if specified, this will add `i` icon next to the parameter name, and once a customer hovers over it with a cursor, the text that is in the tooltip will be displayed

  • `category` - specify the category where the parameter should belong, with parameters sharing the same category being visually grouped together

  • `orderIndex` - specify the order of parameters in the UI in the ascending order

  • `isJsonParam` - if you would like to use the above parameters, you need to set this to `true`. Otherwise, the whole content of {...} will be displayed as the parameter name.

This is an example of how these parameters can be used:

The parameters in the UI will be displayed as follows.


All our predefined templates have their categories set up. These include:

(Script tags will be stripped)

## Supported types

The parameters support multiple common types:

  • `string` - single-lined text

  • `text` - multi-lined text

  • `number`

  • `color` - input using cooler picker

  • `enum` - selection of a single value from a limited collection of values

  • `recommendation`

  • `metric`

  • `date`

  • `time`

  • `datetime`

  • `boolean`

  • `image`

# Examples