Zendesk Query Activity¶

Introduction¶

A Zendesk Query activity, using its Zendesk connection, retrieves object data from Zendesk and is intended to be used as a source to provide data in an operation.

Rate Limits¶

The Zendesk REST API, which is used by the Zendesk connector, enforces a series of rate limits depending on a number of factors. Read about the limits in the Zendesk documentation.

Create a Zendesk Query Activity¶

An instance of a Zendesk Query activity is created from a Zendesk connection using its Query activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an Activity Instance in Component Reuse.

An existing Zendesk Query activity can be edited from these locations:

• The design canvas (see Component Actions Menu in Design Canvas).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).

Configure a Zendesk Query Activity¶

Follow these steps to configure a Zendesk Query activity:

• Step 1: Enter a Name and Select an Object
  Provide a name for the activity and select an object.

• Step 2: Review the Data Schemas
  Any request or response schemas are displayed.

Step 1: Enter a Name and Select an Object¶

In this step, provide a name for the activity and select an object. Each user interface element of this step is described below.

• Name: Enter a name to identify the activity. The name must be unique for each Zendesk Query activity and must not contain forward slashes / or colons :.

• Select an Object: This section displays objects available in the Zendesk endpoint.

  • Selected Zendesk Object: After an object is selected, it is listed here.

  • Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload objects from the Zendesk endpoint. This may be useful if objects have been added to Zendesk. This action refreshes all metadata used to build the table of objects displayed in the configuration.

  • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the Zendesk endpoint:

    • Name: The name of the Zendesk object.

    • Description: The description of the Zendesk object.

  Tip

  If the table does not populate with available objects, the Zendesk connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Maximum Number of Pages: Enter the maximum number of pages to be returned. Each page returns 100 records. By default, if a value is not provided, one page is returned.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas¶

Any request or response schemas are displayed. Each user interface element of this step is described below.

• Data Schemas: The request and response data schemas for Zendesk will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

  Note

  Data supplied in a transformation takes precedence over the activity configuration.

  The Zendesk connector uses the Zendesk Rest API; see the API for information on the schema fields of supported objects.

  The request and response data schemas consist of these nodes and fields:

  • Request:

    Request Schema Field/Node	Notes
    queryRequest	Query request
    item	The Group items
    property	A group property keyword, either name or created
    operator	A search operator, one of :, <, >, <=, >=, " ", -, or *
    searchTerm	A search term consisting of a user-defined word, phrase, or value

  • Response:

    Response Schema Field/Node	Notes
    queryResponse	Query response
    item	The Group items in JSON Format
    deleted	A boolean indicating if the group is marked as deleted
    updated_at	The time of the last update of the group
    name	The name of the group
    created_at	The time that the group was created
    id	An integer assigned during group creation
    url	The API URL of the group

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Zendesk endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Finished: Click to save the configuration for all steps and close the activity configuration.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps¶

After configuring a Zendesk Query activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Zendesk Query activities can be used as a source with these operation patterns:

• Transformation Pattern
• Two-target Archive Pattern (as the first source only)
• Two-target HTTP Archive Pattern (as the first source only)
• Two-transformation Pattern (as the first or second source)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.