Search Fields#

Overview#

Search Fields answer the question: what details can a user provide when setting up a Search?

These details might include:

  • Name to query for a Contact (EG: Salesforce)
  • Repo to restrict search to for an Issue (EG: Github)
  • Notebook for a Note (EG: Evernote)

What a user sees:

What a developer sees:

Each Search should have at least one Search Field, because otherwise we won't know what to include in the query.

You can also dynamically load custom Search Fields by inspecting a custom field endpoint of your own. Learn more.

Search Field Options#

Key#

A key for you and your API's consumption. This is available for variable syntax in the Search URL field as well as in Scripting. Needs to be at least two characters long, start with an alpha, and only contain a-z, A-Z, 0-9 or _.

Example:
room

Label#

A human readable Label shown in the UI as a user works to complete a Search.

Example:
Email or Name

label help default

Help Text#

Human readable description of a Search field, useful for describing some detail you couldn't list in the Label.

Example:
Specify the first name to search by. or Restrict the search to contacts in this category.

Default#

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 Search, 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.

Type#

The type we will try to coerce to on the backend. Fails silently to ensure that tasks aren't dropped on coercion errors.

You can get a full list of supported types and the coercion implied here: Field Types.

Required#

If checked a user will not be able to continue without entering some value.

Dynamic Dropdown#

Use an existing Trigger to load in values for selection, using the machine readable value your API consumes (like id or hash) while showing a human readable version to the user (like name or itemName).

Refer to our dynamic dropdown docs for a more in depth explanation.

Example:
TRIGGERKEY.id.name or TRIGGERKEY.hash.itemName

dynamic dropdown

Static Dropdowns#

A comma separated string that will be turned into a select field for limiting the choices a user can provide to a Search field.

Example:
choice_a,choice_b,choice_c or Yesterday, Today, Tomorrow

simple static dropdown

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.

Example:
1|Option 1,2|Option 2

simple static dropdown as key-value pairs

List#

Indicates if this field can hold multiple values. For example, this could be useful if you want to allow users to search for a contact by name, but limit the search to contacts with one or more tags applied. List fields gain the +/- icons to the side.

list field example

↑ Was this documentation useful? Yes No
Get Help