Zendesk

The Zendesk destination syncs user data to your Zendesk customer support system.

Destination Info

• Supports Identify calls

• Does not support Track track calls and will not appear as a destination option in the event library.

• Supports HIPAA mode

• Supported Connection Modes:

	Client-side	Server-side
Web
Mobile
Server

Getting Started

To set up the Zendesk integration, follow these steps:

1. Go to the Zendesk Configuration page in Freshpaint and click "Configure"

2. Enter your Zendesk subdomain. Find this value in the address bar when you visit your zendesk portal. For example if your Zendesk portal URL is https://mycompany.zendesk.com/agent/filters/1165384057000 then you would enter mycompany.

3. Enter the email address associated with your Zendesk account.

4. Generate an API token that Freshpaint can use to access Zendesk and copy/paste it into Freshpaint.

Identify

When you call freshpaint.identify(), Freshpaint will create or update a user profile in Zendesk.

The Zendesk destination uses the Zendesk Create or Update User API

Required Properties

Zendesk requires a user ID and the user's name. For example, using the Freshpaint Web SDK, you would call freshpaint.identify("some_user_id", {"name": "Some User"}). The user will not be synced to Zendesk if either the user ID or the user's name are not provided.

To send the user's name to Zendesk, you may either use

• the name user property, or

• both the firstName and lastName user properties

The following user properties, when included in the freshpaint.identify() call, will be sent to Zendesk:

Property	Type
email	string
organizationId	integer
timezone	string
phone	string

To send the user's company name to Zendesk, use the nested user property company.name. For example using the Freshpaint Web SDK you would call freshpaint.identify({"company": {"name": "Acme, Inc"}})

Additional user properties will be sent to Zendesk as User Fields. A Zendesk admin will need to configure custom user fields for your account in order to use these.