Get Organizations activity

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


Get Organizations activity

Configure the Get Organizations activity

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

Prerequisites

Good to Know

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 Organizations Get Organizations 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 Organizations 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 Organizations Configuration > Request tab

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

Figure: Get Organizations Configuration > Request tab

Get Organizations 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.

Organization Details

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

Number of Organizations to Retrieve

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

Organization IDs

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

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Get Organizations Configuration > Response tab

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

Figure: Get Organizations Configuration > Response tab

Get Organizations 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 organizations 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
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Store the Response in this Variable

Function:
Specifies the process data variable that stores an information about the retrieved organizations 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:
[{"Details":"","DomainNames":["gmail.com"],"ExternalId":null,"GroupId":null,"Name":"ABC","Notes":"","OrganizationFields":{},"SharedComments":false,"SharedTickets":false,"Tags":[],"CreatedAt":"\/Date(1528965061000)\/","Id":360032614154…}]