Update User (Zendesk) activity

An activity that changes the specified user information in Zendesk.


Update User activity

Configure the Update User activity

To configure the Update User 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 Update User Update User icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Update User 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

Update User Configuration > Basic tab

Specifies information about the user to change from Zendesk.

Figure: Update User Configuration > Basic tab

Update User Configuration Basic 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.

Upload Profile Picture

Function:
Specifies an image to show in your Zendesk user profile.
Accepted Values:
  • Selected - Uses an image for Zendesk user profile.
  • Deselected - Does not use an image for Zendesk user profile.

The image file can be one of these types:

  • .jpg
  • .png
  • .jpeg
  • .gif
  • .bmp
Default Value:
Deselected

User ID

Function:
Specifies the user ID for the Zendesk users whose information to change.
Accepted Values:
A valid Zendesk user ID.
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.

User Name

Function:
Specifies the name of the user to create in Zendesk.
Accepted Values:
A valid user name.
Default Value:
None
Accepts Process Data Variables:
Yes

Email ID

Function:
Specifies the e-mail ID to create a user in Zendesk.
Accepted Values:
A valid e-mail address.
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.

User Role

Function:
Specifies the role of the user to create in Zendesk.
Accepted Values:
  • End-User
  • Agent
  • Admin
Default Value:
None
Accepts Process Data Variables:
Yes

Organization ID

Function:
Specifies the organization ID for the Zendesk organization in which to create a user.
Accepted Values:
A valid Zendesk organization ID.
Default Value:
None
Accepts Process Data Variables:
Yes

Update User Configuration > Advanced tab

Connects the request data from Zendesk to your schema
Figure: Update User Configuration > Advanced tab

Update User Configuration Advanced 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.

Upload Profile Picture

Function:
Specifies an image to show in your Zendesk user profile.
Accepted Values:
  • Selected - Uses an image for Zendesk user profile.
  • Deselected - Does not use an image for Zendesk user profile.

The image file can be one of these types:

  • .jpg
  • .png
  • .jpeg
  • .gif
  • .bmp
Default Value:
Deselected

User ID

Function:
Specifies the user ID for the Zendesk users whose information to change.
Accepted Values:
A valid Zendesk user ID.
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.

Request Mapping

Function:
Connects the Zendesk request to your schema.
To Open this Field:
  1. Click the Advanced tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

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

Default Value:
None

Update User Configuration > Response tab

Specifies how to store the information about the user in process data variables.

Figure: Update User Configuration > Response tab

Update User 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.

Upload Profile Picture

Function:
Specifies an image to show in your Zendesk user profile.
Accepted Values:
  • Selected - Uses an image for Zendesk user profile.
  • Deselected - Does not use an image for Zendesk user profile.

The image file can be one of these types:

  • .jpg
  • .png
  • .jpeg
  • .gif
  • .bmp
Default Value:
Deselected

User ID

Function:
Specifies the user ID for the Zendesk users whose information to change.
Accepted Values:
A valid Zendesk user ID.
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.

Map Response to AgilePoint Schema

Function:
Maps information about the user 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 variable that stores an information about the user 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,…}]

Source Repository

Specifies the original, or source, location type for your user profile image files.

Figure: Source Repository screen

Source Repository screen

Fields

Field Name Definition

Amazon S3 Amazon S3 icon

Function:
Specifies that Amazon S3 is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Amazon S3) - Update User (Zendesk).

Box Box icon

Function:
Specifies that Box is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Box) - Update User (Zendesk).

Dropbox Dropbox icon

Function:
Specifies that Dropbox is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Dropbox) - Update User (Zendesk).

FTP FTP icon

Function:
Specifies that FTP is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (FTP) - Update User (Zendesk).

Google Drive Google Drive icon

Function:
Specifies that Google Drive is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Google Drive) - Update User (Zendesk).

NetSuite NetSuite icon

Function:
Specifies that NetSuite is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (NetSuite) - Update User (Zendesk).

OneDrive OneDrive icon

Function:
Specifies that OneDrive is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (OneDrive) - Update User (Zendesk).

OneDrive For Business OneDrive For Business icon

Function:
Specifies that OneDrive for Business is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (OneDrive For Business) - Update User (Zendesk).

Salesforce Salesforce icon

Function:
Specifies that Salesforce is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Salesforce) - Update User (Zendesk).

SFTP SFTP icon

Function:
Specifies that SFTP is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (SFTP) - Update User (Zendesk).

SharePoint SharePoint icon

Function:
Specifies that SharePoint is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (SharePoint) - Update User (Zendesk).

File System File System icon

Function:
Specifies that the file system on the AgilePoint Server machine is the data source for the file.

To select your file in the source location, complete the fields on Source Repository Configuration (File System) - Update User (Zendesk).