For the complete documentation index, see llms.txt. This page is also available as Markdown.

Select Filters Template

Overview

Run the Select Filters Template action from a handler.

This action loads a saved Filter Template into the Filter Panel. It does not apply conditions. Users can review the filters and click Apply.

Handlers and actions

  • Handler: defines what happens when a user clicks a Kanban UI element.

  • Action: an executable operation triggered by the handler.

  • Primary action here: Kanban API → Select Filters Template.

  • Optional follow-ups: configure extra actions on success or failure.

See Configuring Handlers.

Key concepts

Filter Template A saved set of filter conditions. Templates can contain placeholders populated at runtime.

Filter Panel The panel where active filter conditions are displayed and managed.

Configuration

Configure the handler on the interactive element.

Primary action type Kanban API

Primary action Select Filters Template

Action parameters JSON object used to select the template and provide substitution values.

This action replaces the current Filter Panel state. It still does not apply conditions. Chain Apply Filter Conditions if you want auto-apply.

Parameters

Name

Description

Required

template

The name of the Filter Template to load.

Yes

values

JSON object containing values used to populate filter items defined in the template.

No

values notes

  • Keys must match the template’s field names.

  • Values can be static values or runtime expressions.

Example


Behavior

When the handler runs the action:

  1. Retrieves the filters list from the specified Filter Template.

  2. Applies provided values to the template filter items.

  3. Replaces all existing active filters in the Filter Panel with the result.

  4. Does not apply conditions automatically — the Filter Panel opens with the pre-populated filters, and the user must click Apply to activate them.

Troubleshooting

The Filter Panel opens empty. The template value may reference a missing template. Names are case-sensitive.

Template values are not substituted. Keys in values must match the template’s field names. Use API names like Opportunity.StageName.

Existing filters are removed. This is expected. Use Merge Filters Template to preserve user filters.

Dynamic expressions in values are not resolving. Expressions like {Opportunity.AccountId} resolve only when that context exists. Place the element where the referenced fields are available.

Filters are loaded but the board does not update. This action does not apply conditions. Users must click Apply.

Last updated