Trigger Fields answer the question: How can a user filter Triggers? Almost exclusively these are dynamic dropdowns, but some real world examples are:
Imagine an endpoint like
https://example.com/api/v1/prospects.json- that would require no trigger fields at all. However an endpoint like
https://example.com/api/v1/list/1234/prospects.json- that would require at least a trigger field to select the list ID (and it would be a dynamic dropdown at that!).
What a user sees:
What a developer sees:
When you attempt to add a trigger field, you'll be prompted to provide some options which are outlined below.
A key for your internal use. It is available for variable syntax in the Trigger URL field (as well as in scripting). Needs to be at least two characters long, start with an alpha, and only contain
A human readable Label shown in the UI as a user builds a Zap.
Human readable description of a trigger field, useful for describing some detail you couldn't list in the Label.
Choose which project to watch for new messages. or
Define a search term for finding Tweets.
A default value for a field. The behavior varies between required and optional fields. For required fields, the default will be set once when the user first creates the Trigger, but it is not guaranteed after that (we raise an error on missing/null values instead). For optional fields, it is set on initial creation and used in place of missing or null values every time the Zap runs.
The type we will try to coerce to. Falls back to unicode (text) if coercion fails.
If checked a user will not be able to continue without entering some value.
Use an existing Trigger to load in values for selection, using the machine readable value your API consumes (like
hash) while showing a human readable version to the user (like
In our experience, most trigger fields are dynamic dropdowns.
Refer to our dynamic dropdown docs for a more in depth explanation.
A comma separated string that will be turned into a select field for limiting the choices a user can provide to a trigger field.
Yesterday, Today, Tomorrow
If you would like to provide a label for the raw value of each choice, you can also use the raw|label,raw|label syntax instead.
1|Option 1,2|Option 2
Indicates if this field can hold multiple values. For example, this could be useful if you want to allow users to only trigger on new contacts with one or more tags applied. List fields gain the +/- icons to the side.