Search

This activity helps the user search and retrieve specific results based on the provided query from the connected Zendesk account.

Properties

Configuration

Once you select the respective project name where Zendesk has been authenticated, the activity will automatically retrieve the available connections for that project.

If you have not added the connection, click here to learn more. 

Below are the properties available after the project has been integrated:

Zendesk: *This parameter indicates the account name associated with the integration.

Input

Query: *Specifies the query used to search and retrieve results. It accepts values in the “String” data type, which can be provided either as a string value or a string variable.

MaxRecords: Specifies the maximum number of records to retrieve when executing the activity. It accepts values in the “Int32” data type.

Sort by: Indicates the field by which the query results should be sorted. Available options include “created_at, updated_at, priority, status and ticket_type”. 

Sort Order: Specifies the order in which the results should be sorted. You can choose either “Ascending or Descending.”

MISC

DisplayName: Displays the name of the activity. The activity name can be customized, which aids in troubleshooting.

SkipOnError: Specify the “Boolean” value as “True” or “False.”
True: Continue executing the workflow regardless of any errors thrown.
False: Halt the workflow if it encounters any errors.
None: If the option is left blank, the activity will, by default, behave as if “False” were chosen.

Version: It indicates the version of the feature being used.

OUTPUT

Search list: It returns the results from the provided query in a list. 

Result: It provides the ability to view the execution status of the activity. It returns values in “Boolean.”
True: Indicates that the activity has been executed successfully without any errors.
False: Indicates that the activity has been unsuccessful due to an unexpected error being thrown.

* Represents mandatory fields to execute the workflow.

Example Queries

1. query=1234567- It returns the ticket ID “1234567” and its details.
2. type:user name:test – It returns the usernames that contains test.
3. type:organization created<2015-05-01 – It returns the organizations created before 01-05-2015 as the result.