Get Users (Zendesk) activity

An activity that gets an information about one or more users in Zendesk.


Get Users activity

Configure the Get Users activity

To configure the Get Users activity, do the procedure in this topic.

Prerequisites

Good to Know

  • ​​To send an e-mail notification, click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Zendesk Zendesk icon tab.
      2. On the Zendesk Zendesk icon tab, drag the Get Users Get Users icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Get Users activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Get Users Configuration > Request tab

Specifies the information about one or more users to get from Zendesk.

Figure: Get Users Configuration > Request tab

Get Users Configuration Request tab

Fields

Field Name Definition

Zendesk

Function:
Specifies the access token that connects to your Zendesk service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Add Token Add Token icon

Opens this Screen:
Access Token for Zendesk
Function of this Screen:
Configure an access token to connect to Zendesk.

Users Details

Function:
Specifies which users' details to get in Zendesk.
Accepted Values:
  • Get All Users Details - Gets the information about all users.
  • Get Specified Users Details - Gets the information about the users you specify.
Default Value:
None

Number of Users to Retrieve

Function:
Specifies the number of users whose information to get in Zendesk.
Accepted Values:
An integer.
Default Value:
None
Accepts Process Data Variables:
Yes

User IDs

Function:
Specifies the user IDs for the Zendesk users whose information to get.
Accepted Values:
One or more Zendesk user IDs, separated by semicolons (;).
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

The configuration details AgilePoint NX Product Documentation can provide for third-party integrations is limited. For more information, refer to the relevant section in Third-Party Vendor Documentation.

Get Users Configuration > Response tab

Specifies how to store the information about one or more users in process data variables.

Figure: Get Users Configuration > Response tab

Get Users Configuration Response tab

Fields

Field Name Definition

Zendesk

Function:
Specifies the access token that connects to your Zendesk service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Add Token Add Token icon

Opens this Screen:
Access Token for Zendesk
Function of this Screen:
Configure an access token to connect to Zendesk.

Map Response to AgilePoint Schema

Function:
Maps information about the users from the Zendesk data model to your schema.
To Open this Field:
  1. Click the Response tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Default Value:
None

Store the Response in this Variable

Function:
Specifies the process data variablethat stores an information about the retrieved users from the Zendesk.
To Open this Field:
  1. Click the Response tab.
Accepted Values:
A process data variable that accepts an alphanumeric string in JSON format.
Note: In most cases, AgilePoint recommends the Map Response to AgilePoint Schema option. Only get the raw JSON string if you need this data for custom coding.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
[{"Active":true,"Alias":null,"CustomFields":{},"CustomRoleId":null,"Email":"mrzentest5@gmail.com","ExternalId":null,"LastLoginAt":"\/Date(1529558303000)\/","LocaleId":1,"Moderator":true,"Name":"Mr Zen","Notes":null,"OnlyPrivateComments":false,"OrganizationId":360032614154,…}]