diff --git a/src/connections/destinations/catalog/zendesk/index.md b/src/connections/destinations/catalog/zendesk/index.md index 16fa44f63e..1f57b36012 100644 --- a/src/connections/destinations/catalog/zendesk/index.md +++ b/src/connections/destinations/catalog/zendesk/index.md @@ -124,9 +124,9 @@ analytics.track('Article Completed', { }); ``` -**Important:** To make track calls, you must sign up for Zendesk's [User Events API early access program](https://develop.zendesk.com/hc/en-us/community/topics/360000030527) +**Important:** You must have a Zendesk [Sunshine plan](https://www.zendesk.com/pricing/?variant=a#platform) to make track calls. -When you call `track` we will send data about a user's activity to Zendesk. +When you make a Track call, Segment sends data about the user's activity to Zendesk. We will only send `track` events when the following two conditions are met: @@ -134,6 +134,18 @@ We will only send `track` events when the following two conditions are met: 2. A `userId` is included. - **Note:** If the `userId` doesn't match any existing users in Zendesk, we will return an error. +**Mapping Users to an Email**: To map a Segment track event to a Zendesk Sunshine event by email, add the user's email address in the Track call as `properties.email`. This allows Zendesk to tie the event to the user. If there is no `properties.email`, Segment sends the `userId` as `external_id`. If the email is provided in the track call, a javascript call may look like the example below. + +```js +analytics.track('Article Completed', { + title: 'How to Create a Tracking Plan', + course: 'Intro to Analytics', + properties: { + email : 'user@example.com', + } +}); +``` + ## Group If you're not familiar with the Segment Specs, take a look to understand what the [Group method](https://segment.com/docs/connections/spec/group/) does. An example call would look like: