Search Zendesk

This Snap has at most one document input view.

When connected, field values from the incoming document can be referenced in expression-enabled fields using the $ notation.

• Mapper

This Snap has one document output view.

Each search result is emitted as a separate document. The structure of the output document varies depending on the object type returned (ticket, user, article, post, and so on).

• Mapper

Label

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Search Zendesk

Default value: Tickets / Users / Organizations

Appears when Search Scope is Tickets / Users / Organizations.

Enter a comma-separated list of Zendesk object types to restrict search results to. Equivalent to adding type:<value> tokens to the query. Valid values: ticket, user, organization, group.

Default value: None

Example: ticket,user

Enter the search query string. Supports Zendesk search syntax. Maps to the query parameter of the /api/v2/search endpoint.

When Search Scope is Tickets / Users / Organizations or Community Posts, the field is displayed as Query* and a value is mandatory. For the two Help Center scopes, the field is optional only for Help Center (Articles + Posts); for Help Center Articles, it is required unless Categories, Sections, or Label Names is set.

Default value: None

Example: type:ticket status:open

Default value: Relevance

Example: Updated At

Default value: Descending

Example: Ascending

Specify a locale to restrict results to that locale. Leave empty to return results in all locales.

When Search Scope is Help Center (Articles + Posts), the field is displayed as Locale* and a value is mandatory.

Default value: en-us

Example: fr

Specify the maximum number of search results to emit per execution. Zendesk search endpoints return at most 1000 results per query, so this field accepts values from 0 through 1000. Enter 0 or leave empty to emit up to that 1000-result maximum.

A value greater than 1000 supplied through an expression is rejected when the Snap runs.

Default value: 0

Example: 100

Enter the number of times the Snap should retry the API call on connection errors or 5xx responses. On a 429 response, the Snap automatically retries after the interval specified in the server's Retry-After header, overriding the Retry interval value. On a 401 response, the Snap reloads the account credentials and retries before counting the attempt against this limit.

Default value: 5

Example: 3

Enter the number of seconds to wait between retry attempts.

Default value: 3

Example: 5

Snap execution

Default value: Validate & execute

Enter the search query string. Supports Zendesk Help Center search syntax. Maps to the query parameter of the Guide search API.

A value is mandatory unless you set at least one of Categories, Sections, or Label Names, because the Zendesk article search endpoint requires at least one of these four filters.

Default value: None

Example: DITA authoring

Enter a comma-separated list of article label names to filter by. Only articles that match all specified labels are returned.

Default value: None

Example: api,integration

When selected, the search spans articles across all brands in your Zendesk instance. When not selected, the Brand field appears to restrict the search to a single brand.

Default value: Selected

Appears when Multi-brand is not selected.

Specify the single brand to restrict the article search to. Suggestions are populated from your Zendesk instance when the account is configured.

Select or enter the brand name exactly as it appears in Zendesk. The Snap resolves the name to its numeric ID and fails if no match exists in your instance.

Default value: None

Example: Support

When selected, the Snap makes an additional API call per article to retrieve attachment metadata, which is included in each article output document.

Default value: Not selected

Default value: Relevance

Example: Created At

Default value: Descending

Example: Ascending

Enter the search query string. Supports Zendesk community search syntax. Maps to the query parameter of the Guide community search API.

Displayed as Query*. A value is mandatory for this scope.

Default value: None

Example: installation error

Enter the numeric Zendesk topic ID to restrict the search to community posts within that topic.

Default value: None

Example: 360001234567

Default value: Relevance

Example: Created At

Default value: Descending

Example: Ascending

Enter the search query string. Supports Zendesk Guide search syntax. Maps to the query parameter of the unified Guide search API.

Optional for this scope. Leave empty to return every article and post that matches Locale* and the other filters.

Default value: None

Example: getting started

Default value: Relevance

Example: Created At

Default value: Descending

Example: Ascending