Skip to Content

Zendesk Delete Activity

Introduction

A Zendesk Delete activity, using its Zendesk connection, deletes object data from Zendesk and is intended to be used as a target to consume 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 Delete Activity

An instance of a Zendesk Delete activity is created from a Zendesk connection using its Delete 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 Creating an Activity Instance in Component Reuse.

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

Configure a Zendesk Delete Activity

Follow these steps to configure a Zendesk Delete activity:

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.

Zendesk Delete Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each Zendesk Delete 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 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.

  • Continue on Error: Select to continue the operation if an error is encountered. If any errors are encountered, they are written to the operation log. The default value is unselected.

  • 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.

Zendesk Delete Activity Configuration Step 2

  • 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 Zendesk connector supports the Group, Organization, Users, Ticket, and Ticket Comment Zendesk API objects.

    These are the schema fields shown in the example screenshot above:

    • Request:

      Request Schema Field/Node Notes
      deleteRequest Delete request
      ids The Group
      item The Group items
      #text The ID of the group to be deleted
    • Response:

      Response Schema Field/Node Notes
      deleteResponse Delete response
      item The Group items
      id The ID of the group
      error Errors returned by the API
  • Refresh: Click the refresh icon 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 Delete 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 Delete activities can be used as a target with these operation patterns:

A typical use case is to use a Zendesk Delete activity in the Two-transformation Pattern. In this example, the first transformation (Delete Request) creates a request structure that is passed to the Zendesk Delete activity. The second transformation (Delete Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Delete Response) and a message is then logged by the Write to Operation Log script:

Zendesk Delete operation

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.