Skip to content

Commit 9e5bb40

Browse files
coreychingmarkzegarellisanscontextpauljaeinyoo
authored
Updating Zendesk Docs to include new information on Sunshine Events. (#1577)
* Updating Zendesk Docs to include new information on Suinshine Events. * verbiage [netlify-ignore] * Update src/connections/destinations/catalog/zendesk/index.md Co-authored-by: LRubin <[email protected]> * Update src/connections/destinations/catalog/zendesk/index.md Co-authored-by: LRubin <[email protected]> * Update src/connections/destinations/catalog/zendesk/index.md Co-authored-by: LRubin <[email protected]> * When "you" make typo Co-authored-by: markzegarelli <[email protected]> Co-authored-by: LRubin <[email protected]> Co-authored-by: pauljaeinyoo <[email protected]>
1 parent d6c47fd commit 9e5bb40

File tree

1 file changed

+14
-2
lines changed
  • src/connections/destinations/catalog/zendesk

1 file changed

+14
-2
lines changed

src/connections/destinations/catalog/zendesk/index.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,16 +124,28 @@ analytics.track('Article Completed', {
124124
});
125125
```
126126

127-
**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)
127+
**Important:** You must have a Zendesk [Sunshine plan](https://www.zendesk.com/pricing/?variant=a#platform) to make track calls.
128128

129-
When you call `track` we will send data about a user's activity to Zendesk.
129+
When you make a Track call, Segment sends data about the user's activity to Zendesk.
130130

131131
We will only send `track` events when the following two conditions are met:
132132

133133
1. The call is listed in the "Events" setting.
134134
2. A `userId` is included.
135135
- **Note:** If the `userId` doesn't match any existing users in Zendesk, we will return an error.
136136

137+
**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.
138+
139+
```js
140+
analytics.track('Article Completed', {
141+
title: 'How to Create a Tracking Plan',
142+
course: 'Intro to Analytics',
143+
properties: {
144+
email : '[email protected]',
145+
}
146+
});
147+
```
148+
137149
## Group
138150

139151
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:

0 commit comments

Comments
 (0)