Filter Fields

This article gives the available options for filter fields for your triggers.

To learn how to configure a trigger with filter fields, see Add an Automations Trigger Extension.

Number

Number filters allow users to set a number threshold for a given payload property. If you configure this filter, it's a required field for users when they use your trigger.

Example use case:
A customer buys 5 products.

This table shows the available configuration options:

OptionDetails
Label (user-facing)Use this field to describe the options the user is selecting.
Tooltip (user-facing)Give users more information or explain how this field affects the automation. If left empty, the tooltip icon isn't displayed.
Select the item's property from your schemaThe property in the payload that's used to filter the trigger.
Minimum valueMinimum value the user can set.
Maximum valueMaximum value the user can set.
Default valueDefault value displayed to the user.
Comparison operatorComparison operator to set the filter to. Currently limited to Equal to.

Toggle (boolean)

Toggle filters allow users to compare a boolean value against a payload property. If you configure this filter, it's a required field for users when they use your trigger.

This table shows the available configuration options:

OptionDetails
Label (user-facing)Use this field to describe the options the user is selecting.
Tooltip (user-facing)Give users more information or explain how this field affects the automation. If left empty, the tooltip icon isn't displayed.
Select the item's property from your schemaThe property in the payload that's used to filter the trigger.
Default stateDefault value displayed to the user.

Dropdown filters allow users to select one or more specific values from a dropdown list to compare against a payload property. You define the static list of options at the time you're configuring the filter field. If you configure this filter, it's a required field for users when they use your trigger.

Example use case:
A customer buys a specific product, specified by you.

This table shows the available configuration options:

OptionDetails
Label (user-facing)Use this field to describe the options the user is selecting.
Tooltip (user-facing)Give users more information or explain how this field affects the automation. If left empty, the tooltip icon isn't displayed.
Select the item's property from your schemaThe property in the payload that's used to filter the trigger.
Enter dropdown choicesUse this option to provide a static set of options to the user. One per line, with a comma separating display name (user-facing) and value passed in the payload.
Choose a selection methodSupported values:
  • Multiple: Allow the user to select multiple options from the dropdown.
  • Single: Limit the user to a single option selection.

Item selection

Item selection filters allow users to select one or more specific items on their site from a dropdown list to compare against a payload property. The dropdown list of items is dynamically generated based on the user's site. If you configure this filter, it's a required field for users when they use your trigger.

You can optionally configure multiple item selection fields in sequence by clicking Add Follow-up Step. Each follow-up step can be used to filter the step that comes before it.

Example use case:
A customer buys a specific, user-specified product.

This table shows the available configuration options:

OptionDetails
Label (user-facing)Use this field to describe the options the user is selecting.
Tooltip (user-facing)Give users more information or explain how this field affects the automation. If left empty, the tooltip icon isn't displayed.
Item for selection (provider)List of entities from Wix apps. Based on your selection, the user is presented with a selectable list of items when they configure an automation with your trigger. For example, if you select Tiers (Loyalty), users can select one or more loyalty tiers when they configure their automation.
Item from previous step to filter this selection (Search param field)Payload property, linked to the previous step's item selection field, to further filter by.
Select the item's property from your schemaThe property in the payload that's used to filter the trigger.
Choose a selection methodSupported values:
  • Multiple: Allow the user to select multiple options from the dropdown.
  • Single: Limit the user to a single option selection.
Users can set this filter to "all items"If selected, users can choose not to filter by specific items from the dropdown list.
Did this help?