Skip to content

Commit 404a20b

Browse files
author
markzegarelli
authored
DOC 500 zendesk update (#2769)
* Add Vidora to allow list * Added note about Zendesk API limit
1 parent 1ddc980 commit 404a20b

File tree

1 file changed

+18
-15
lines changed
  • src/connections/destinations/catalog/zendesk

1 file changed

+18
-15
lines changed

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

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ id: 54521fdc25e721e32a72ef06
1515
2. Search for "Zendesk" in the Catalog, select it, and choose which of your sources to connect the destination to.
1616
3. There are two ways to authenticate your Zendesk account with Segment:
1717
* Use the standard email and password you use to Sign In to your Zendesk account. In the Zendesk settings, add your email in the **Email** setting and your password in the **Password** setting.
18-
* Use Zendesk OAuth with a unique token. Get the corresponding token from your Zendesk account: **Settings > Channels > API** and under the Settings Tab choose the corresponding token from the "Active API Tokens" list. In the Zendesk settings, add your `email/token` in the **Email** setting (i.e. `[email protected]/token` - use the actual word token in your email address) and add the actual token in the **Password** setting.
18+
* Use Zendesk OAuth with a unique token. Get the corresponding token from your Zendesk account: **Settings > Channels > API** and under the Settings Tab choose the corresponding token from the "Active API Tokens" list. In the Zendesk settings, add your `email/token` in the **Email** setting (for example, `[email protected]/token` - use the actual word token in your email address) and add the actual token in the **Password** setting.
1919
4. Add your Zendesk subdomain in the **Subdomain** setting (not including `.zendesk.com`).
2020

2121
## Identify
@@ -31,7 +31,7 @@ analytics.identify("97980cfea0067", {
3131
});
3232
```
3333

34-
When you call `identify` we will insert or update a user record in Zendesk. We'll use the user email in `traits.email` to match user records in Zendesk. If there are multiple users matching the email, then no updates are submitted. Note that you must provide a trait for either `name` or `first_name` and `last_name` in order for the `identify` call to send to Zendesk. If you provide a `name`, we will parse this into the `first_name` and `last_name` fields.
34+
When you call `identify`, Segment inserts or updates a user record in Zendesk and uses the user email in `traits.email` to match user records in Zendesk. If there are multiple users matching the email, then no updates are submitted. Note that you must provide a trait for either `name` or `first_name` and `last_name` in order for the `identify` call to send to Zendesk. If you provide a `name`, Segment parses this into the `first_name` and `last_name` fields.
3535

3636
Here's an example:
3737

@@ -61,7 +61,7 @@ Here's an example:
6161
}
6262
```
6363

64-
By default, Users in Zendesk have many standard attributes associated with a single User record. Segment, at this time, is mapping to a subset of these. If you attempt to send data to a Zendesk attribute that we have not yet mapped, it will create a custom field for this (it will not update the existing attribute).
64+
By default, Users in Zendesk have many standard attributes associated with a single User record. Segment, at this time, is mapping to a subset of these. If you attempt to send data to a Zendesk attribute that are not yet mapped, it will create a custom field for this (it will not update the existing attribute).
6565

6666
Here are the Zendesk User Attributes Segment maps to and their syntax.
6767

@@ -79,7 +79,7 @@ Here are the Zendesk User Attributes Segment maps to and their syntax.
7979

8080
### Removing Users from a Zendesk Organization Membership on Segment Identify
8181

82-
To remove a user from an organization, navigate to your Zendesk destination settings and click **Enable Removing Users from Organizations** . When this setting is enabled, Segment detects when you pass an identify events with `traits.company.id` where `traits.company.remove: true`, and then sends a request to the Zenedesk API to remove the user from the organization. If you enable the setting in your Zendesk destination settings but do not pass the correct trait values, Segment defaults to the standard `identify` behavior, which creates or updates a user.
82+
To remove a user from an organization, navigate to your Zendesk destination settings and click **Enable Removing Users from Organizations** . When this setting is enabled, Segment detects when you pass an identify events with `traits.company.id` where `traits.company.remove: true`, and then sends a request to the Zendesk API to remove the user from the organization. If you enable the setting in your Zendesk destination settings but do not pass the correct trait values, Segment defaults to the standard `identify` behavior, which creates or updates a user.
8383

8484
Here's an example:
8585
```js
@@ -105,11 +105,11 @@ Here's an example:
105105
106106
### Zendesk Verification Email at User Creation
107107

108-
To limit identified users from receiving a verification email from Zendesk, simply enable the **"Create Users as Verified"** option in the Zendesk destination settings. We will send `verified` as either true or false for each request based on this setting (you cannot overwrite this on a per-request basis).
108+
To limit identified users from receiving a verification email from Zendesk, simply enable the **"Create Users as Verified"** option in the Zendesk destination settings. Segment sends `verified` as either true or false for each request based on this setting (you cannot overwrite this on a per-request basis).
109109

110110
### Zendesk Custom User Fields
111111

112-
You may map to custom user fields within Zendesk by passing your custom field key-value pair as a trait in the Identify call. When passing traits within the identify event, Segment will first try and map the trait to a known, existing field in Zendesk - either the canned standard fields described above or to a custom field (user_fields). We format the field name from either camelCaseFormat or snake_case_format into snake_case_format. If you're finding that your custom fields are not populating in Zendesk as you would expect check the name formatting with this in mind.
112+
You may map to custom user fields within Zendesk by passing your custom field key-value pair as a trait in the Identify call. When passing traits within the identify event, Segment will first try and map the trait to a known, existing field in Zendesk - either the canned standard fields described above or to a custom field (user_fields). Segment formats the field name from either camelCaseFormat or snake_case_format into snake_case_format. If you're finding that your custom fields are not populating in Zendesk as you would expect check the name formatting with this in mind.
113113

114114
## Track
115115

@@ -122,15 +122,16 @@ analytics.track('Article Completed', {
122122
});
123123
```
124124

125-
**Important:** You must have a Zendesk [Sunshine plan](https://www.zendesk.com/pricing/?variant=a#platform) to make track calls.
125+
> info ""
126+
> You must have a Zendesk [Sunshine plan](https://www.zendesk.com/pricing/?variant=a#platform) to make track calls.
126127
127128
When you make a Track call, Segment sends data about the user's activity to Zendesk.
128129

129-
We will only send `track` events when the following two conditions are met:
130+
Segment will only send `track` events when the following two conditions are met:
130131

131132
1. The call is listed in the "Events" setting.
132133
2. A `userId` is included.
133-
- **Note:** If the `userId` doesn't match any existing users in Zendesk, we will return an error.
134+
- **Note:** If the `userId` doesn't match any existing users in Zendesk, the destination returns an error.
134135

135136
**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.
136137

@@ -143,7 +144,8 @@ analytics.track('Article Completed', {
143144
}
144145
});
145146
```
146-
147+
> warning "Zendesk API Limit"
148+
> Track calls to Zendesk must reference a user identifier of less than 61 characters. While you may create a user with an identifier of greater than 60 characters, track calls that reference that user return a 400 error. This is due to a limitation in the Zendesk Sunshine API.
147149
## Group
148150

149151
If you're not familiar with the Segment Specs, take a look to understand what the [Group method](/docs/connections/spec/group/) does. An example call would look like:
@@ -158,9 +160,10 @@ analytics.group("0e8c78ea9d97a7b8185e8632", {
158160
});
159161
```
160162

161-
**Important:** To make group calls, you _must_ be an Administrator in Zendesk.
163+
> info ""
164+
> To make group calls, you _must_ be an Administrator in Zendesk.
162165
163-
When you call `group` we will insert or update an organization in Zendesk. We'll use the `groupId` you include in the call to match organization records in Zendesk. If there are multiple organizations matching the name, then no updates are submitted.
166+
When you call `group` Segment inserts or update an organization in Zendesk and uses the `groupId` you include in the call to match organization records in Zendesk. If there are multiple organizations matching the name, then no updates are submitted.
164167

165168
Here's an example:
166169

@@ -188,9 +191,9 @@ Here's an example:
188191
}
189192
```
190193

191-
Every time you call group, we will also link the organization to the user making the request.
194+
Every time you call group, Segment links the organization to the user making the request.
192195

193-
By default, Organizations in Zendesk have many standard attributes associated with a single Organization record. Segment, at this time, is mapping to a subset of these. If you attempt to send data to a Zendesk attribute that we have not yet mapped, it will create a custom field for this (it will not update the existing attribute).
196+
By default, Organizations in Zendesk have many standard attributes associated with a single Organization record. Segment, at this time, is mapping to a subset of these. If you attempt to send data to a Zendesk attribute that are not yet mapped, it will create a custom field for this (it will not update the existing attribute).
194197

195198
Here are the Zendesk Organization Attributes Segment maps to and their syntax.
196199

@@ -206,4 +209,4 @@ Here are the Zendesk Organization Attributes Segment maps to and their syntax.
206209

207210
### Zendesk Custom Organization Fields
208211

209-
You may map to custom organization fields within Zendesk by passing your custom field key-value pair as a trait in the Group call. When passing traits within the group event, Segment will first try and map the trait to a known, existing field in Zendesk - either the canned standard fields described above or to a custom field (organization_fields). We format the field name from either camelCaseFormat or snake_case_format into snake_case_format. If you're finding that your custom fields are not populating in Zendesk as you would expect check the name formatting with this in mind.
212+
You may map to custom organization fields within Zendesk by passing your custom field key-value pair as a trait in the Group call. When passing traits within the group event, Segment will first try and map the trait to a known, existing field in Zendesk - either the canned standard fields described above or to a custom field (organization_fields). Segment formats the field name from either camelCaseFormat or snake_case_format into snake_case_format. If you're finding that your custom fields are not populating in Zendesk as you would expect check the name formatting with this in mind.

0 commit comments

Comments
 (0)