Skip to content

Commit 81a78a4

Browse files
committed
Merge branch 'master' into update-edit-links
2 parents 3aca4c0 + b1ef286 commit 81a78a4

File tree

9 files changed

+208
-32
lines changed

9 files changed

+208
-32
lines changed

src/connections/destinations/add-destination.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ You can add multiple instances of a destination using the Segment Config API. Se
131131
- **Mobile sources, and the legacy Project source, cannot connect to multiple instances of a destination.**
132132
- **Warning**: If you bundle one instance of a destination in a mobile source but have other instances of that destination connected to that source you might see unexpected and inconsistent data.
133133
- **You can connect a source to up to 10 instances of a destination if all of the instances use cloud-mode.** Destinations using cloud-mode receive data directly from the Segment servers.
134-
- **Non-mobile sources can only connect to one *device-mode* instance of a destination, in addition to unlimited cloud-mode instances.** A web browser device-mode instance of a destination receives data directly from the user’s browser (instead of through the Segment servers), by bundling a copy of destination’s code with the Segment SDK. Segment can’t bundle multiple copies of the destination SDK and so it can’t send data to multiple instances of the destination from the browser.
134+
- **Non-mobile sources can only connect to one *device-mode* instance of a destination, in addition to up to 10 cloud-mode instances.** A web browser device-mode instance of a destination receives data directly from the user’s browser (instead of through the Segment servers), by bundling a copy of destination’s code with the Segment SDK. Segment can’t bundle multiple copies of the destination SDK and so it can’t send data to multiple instances of the destination from the browser.
135135
- **You cannot connect a source to more than one instance of a destination that operates in device-mode only**. These destinations can only accept data from code directly on the user’s device, and Segment cannot include duplicates of that code for a single source.
136136

137137
For more information see [the compatible destination lists below](#multi-instance-compatible-destinations).
@@ -169,7 +169,7 @@ In this example:
169169
The sections below list the most popular multi-instance Segment destinations. This list is not exhaustive. If you don’t see your favorite destination in these lists, [contact Segment Customer Success](https://segment.com/help/contact/).
170170

171171
##### Cloud-mode and device-mode
172-
The following destinations can receive data from an unlimited number of sources in cloud-mode, and **up to one device-mode connection**.
172+
For the following destinations, a single source can connect to up to 10 instances of the destination in cloud-mode, and **up to one instance in device-mode**.
173173

174174
- [Adobe Analytics](/docs/connections/destinations/catalog/adobe-analytics/)
175175
- [Amplitude](/docs/connections/destinations/catalog/amplitude/)
@@ -183,7 +183,7 @@ The following destinations can receive data from an unlimited number of sources
183183

184184
##### Cloud-mode only
185185

186-
The following destinations can receive data from an unlimited number of sources in cloud-mode, but do not support device-mode connections at all.
186+
For the following destinations, a single source can connect to up to 10 instances of the destination in cloud-mode, but these destinations do not support a device-mode connection at all.
187187

188188
- [ActiveCampaign](/docs/connections/destinations/catalog/activecampaign/)
189189
- [Akita](/docs/connections/destinations/catalog/akita/)
30.1 KB
Loading
32.1 KB
Loading
Lines changed: 79 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,80 @@
11
---
2-
title: 'Cliff Destination'
3-
hidden: true
4-
beta: true
5-
---
2+
title: Cliff Destination
3+
rewrite: true
4+
---
5+
[Cliff](https://cliff.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) monitors all your metrics in real time, detects unexpected changes (such as a sudden spike or dip), and notifies you immediately. It also shows you the root cause behind the unexpected change.
6+
7+
This destination is maintained by Cliff.ai. For any issues with the destination, [contact the Cliff Support team](mailto:[email protected]).
8+
9+
## Getting Started
10+
11+
{% include content/connection-modes.md %}
12+
13+
1. Go to the [Cliff Integrations library](https://app.cliff.ai/apps/anomaly-detection/integrations/inbound).
14+
2. Find "Segment" in the list of available integrations and click **Start**.
15+
3. Name your integration and click **Authorise Segment**.
16+
4. Select your Workspace and Source and click **Allow**.
17+
5. [Create a Data Stream on Cliff](https://app.cliff.ai/apps/anomaly-detection/data-streams/create-streams). Choose which Segment events and dimensions to start monitoring. Enter the name of the event and click the blue **+** button. Repeat to add dimensions. Click **Continue**.
18+
![](images/cliff1.png)
19+
**Note**: Cliff ingests _only_ the events you select in this screen.
20+
6. Select how often Cliff should batch the data that Segment sends.
21+
![](images/cliff2.png)
22+
23+
24+
## Track
25+
26+
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like:
27+
28+
```js
29+
analytics.track('Login Button Clicked')
30+
```
31+
32+
Segment sends Track calls to Cliff as a `track` event.
33+
34+
## Page
35+
36+
If you aren't familiar with the Segment Spec, take a look at the [Page method documentation](https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like:
37+
38+
```js
39+
analytics.page()
40+
```
41+
42+
Segment sends Page calls to Cliff as a `pageview`.
43+
44+
## Screen
45+
46+
If you aren't familiar with the Segment Spec, take a look at the [Screen method documentation](https://segment.com/docs/connections/spec/screen/) to learn about what it does. An example call would look like:
47+
48+
```objc
49+
[[SEGAnalytics sharedAnalytics] screen:@"Home"];
50+
```
51+
52+
Segment sends Screen calls to Cliff as a `screenview`.
53+
54+
## Identify
55+
56+
If you aren't familiar with the Segment Spec, take a look at the [Identify method documentation](https://segment.com/docs/connections/spec/identify/) to learn about what it does. An example call would look like:
57+
58+
```js
59+
analytics.identify('userId123', {
60+
61+
});
62+
```
63+
64+
Segment sends Identify calls to Cliff as an `identify` event.
65+
66+
## Group
67+
68+
If you aren't familiar with the Segment Spec, take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like:
69+
70+
```js
71+
analytics.group("0e8c78ea9d97a7b8185e8632", {
72+
name: "Initech",
73+
industry: "Technology",
74+
employees: 329,
75+
plan: "enterprise",
76+
"total billed": 830
77+
});
78+
```
79+
80+
Segment sends Group calls to Cliff as a `group` event.

src/connections/destinations/catalog/regal-voice/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ analytics.identify({
7777
{
7878
channel: "sms",
7979
subscribed: true,
80-
subscribedAt: "2020-08-25T21:23:43Z",
80+
timestamp: "2020-08-25T21:23:43Z",
8181
ip: "172.16.254.1",
8282
text: "By clicking the 'Submit' button below, I agree to receive automated marketing SMS and calls."
8383
},
8484
{
8585
channel: "voice",
8686
subscribed: true,
87-
subscribedAt: "2020-08-25T21:23:43Z",
87+
timestamp: "2020-08-25T21:23:43Z",
8888
ip: "172.16.254.1",
8989
text: "By clicking the 'Submit' button below, I agree to receive automated marketing SMS and calls."
9090
}]
@@ -95,7 +95,7 @@ Supported messaging channels are: `sms`, `voice` and `email`.
9595

9696
The `ip` field is required if you are opting in users server side.
9797

98-
Make sure to include `subscribedAt` with the exact time the user opted in. Since traits are [cached](/docs/connections/sources/catalog/libraries/website/javascript/identity/#clearing-traits) and sent with subsequent `identify` calls, Regal Voice ignores opt-ins without a `subscribedAt` date.
98+
Make sure to include `timestamp` with the exact time the user opted in. Since traits are [cached](/docs/connections/sources/catalog/libraries/website/javascript/identity/#clearing-traits) and sent with subsequent Identify calls, Regal Voice ignores opt-ins that do not have a `timestamp` date.
9999

100100

101101
## Track

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:

src/connections/sources/catalog/cloud-apps/launchdarkly/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ title: LaunchDarkly Source
55

66
This source is maintained by LaunchDarkly. For any issues with the source, [contact the LaunchDarkly Support team](mailto:[email protected]).
77

8-
{% include content/beta-note.md %}
9-
108

119
## Getting Started
1210

src/connections/sources/catalog/cloud-apps/regal-voice/index.md

Lines changed: 108 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,39 @@ The table below lists events that Regal Voice sends to Segment. These events app
3131
</tr>
3232
<tr>
3333
<td>contact.subscribed</td>
34-
<td>A Contact was subscribed to a marketing channel</td>
34+
<td>A contact was subscribed to a marketing channel</td>
3535
</tr>
3636
<tr>
3737
<td>contact.unsubscribed</td>
38-
<td>A Contact was unsubscribed from a marketing channel</td>
38+
<td>A contact was unsubscribed from a marketing channel</td>
3939
</tr>
4040
<tr>
4141
<td>sms.queued</td>
42-
<td>An sms was queued to be sent from RegalVoice to Contact</td>
42+
<td>An sms was queued to be sent from RegalVoice to contact</td>
4343
</tr>
4444
<tr>
4545
<td>sms.sent</td>
46-
<td>An sms was sent from RegalVoice to Contact</td>
46+
<td>An sms was sent from RegalVoice to contact</td>
4747
</tr>
4848
<tr>
49-
<td>sms.delivered</td>
50-
<td>An sms was delivered from RegalVoice to Contact</td>
49+
<td>sms.undelivered</td>
50+
<td>An sms was undelivered from RegalVoice to contact</td>
5151
</tr>
5252
<tr>
53-
<td>sms.undelivered</td>
54-
<td>An sms was undelivered from RegalVoice to Contact</td>
53+
<td>sms.received</td>
54+
<td>An sms was received from a contact</td>
55+
</tr>
56+
<tr>
57+
<td>task.created</td>
58+
<td>A call or sms task was created</td>
59+
</tr>
60+
<tr>
61+
<td>sms.conversation_completed</td>
62+
<td>An SMS conversation between a contact and an agent was completed in the Regal Voice agent desktop</td>
63+
</tr>
64+
<tr>
65+
<td>call.completed</td>
66+
<td>An inbound or outbound call with a contact was completed. This includes calls that were not answered</td>
5567
</tr>
5668
</table>
5769

@@ -64,16 +76,15 @@ The table below lists events that Regal Voice sends to Segment. These events app
6476
</tr>
6577
<tr>
6678
<td>`channel`</td>
67-
<td>Marketing channel of the subscription update. Acceptible value are: "voice", "sms", "email"
68-
</td>
79+
<td>The marketing channel: "voice" or "sms"</td>
6980
</tr>
7081
<tr>
7182
<td>`phone`</td>
72-
<td>The phone number the subscription update was applied to. Phone number is the unique identifier for a Contact in Regal Voice</td>
83+
<td>The phone number the subscription update was applied to. Phone number is the unique identifier for a contact in Regal Voice</td>
7384
</tr>
7485
<tr>
7586
<td>`email`</td>
76-
<td>The last email associated with the Contact</td>
87+
<td>The last email associated with the contact</td>
7788
</tr>
7889
<tr>
7990
<td>`ip`</td>
@@ -87,18 +98,18 @@ The table below lists events that Regal Voice sends to Segment. These events app
8798
</tr>
8899
<tr>
89100
<td>`text`</td>
90-
<td>Only applies to contact.subscribed event. The exact text the Contact was presented for opt in</td>
101+
<td>The exact text the contact was presented for opt in</td>
91102
</tr>
92103
<tr>
93104
<td>`timestamp`</td>
94105
<td>Unix timestamp for when the event took place</td>
95106
</tr>
96107
<tr>
97108
<td>`contact_phone`</td>
98-
<td>Phone number of the Contact</td>
109+
<td>Phone number of the contact</td>
99110
</tr>
100111
<tr>
101-
<td>`regal_voice_number`</td>
112+
<td>`regal_voice_phone`</td>
102113
<td>RegalVoice phone number</td>
103114
</tr>
104115
<tr>
@@ -107,7 +118,7 @@ The table below lists events that Regal Voice sends to Segment. These events app
107118
</tr>
108119
<tr>
109120
<td>`direction`</td>
110-
<td>Direction of the SMS (INBOUND or OUTBOUND)</td>
121+
<td>INBOUND or OUTBOUND</td>
111122
</tr>
112123
<tr>
113124
<td>`from_number`</td>
@@ -123,7 +134,87 @@ The table below lists events that Regal Voice sends to Segment. These events app
123134
</tr>
124135
<tr>
125136
<td>`sms_conversation_id`</td>
126-
<td>Unique ID of the conversation (if the sms was part of a two-way conversation with an Agent, rather than just an automated outbound sms)</td>
137+
<td>Task ID for the conversation. (If the sms was part of a two-way conversation with an Agent, rather than just an automated outbound sms)</td>
138+
</tr>
139+
<tr>
140+
<td>`campaign_friendly_id`</td>
141+
<td>Campaign Friendly Id as seen in the App</td>
142+
</tr>
143+
<tr>
144+
<td>`campaign_id`</td>
145+
<td>Campaign Id</td>
146+
</tr>
147+
<tr>
148+
<td>`campaign_name`</td>
149+
<td>Campaign Name</td>
150+
</tr>
151+
<tr>
152+
<td>`queue`</td>
153+
<td>Task Queue</td>
154+
</tr>
155+
<tr>
156+
<td>`scheduling_agent_fullname`</td>
157+
<td>Full name of the agent who scheduled the Callback</td>
158+
</tr>
159+
<tr>
160+
<td>`scheduling_agent_id`</td>
161+
<td>Email of the agent who scheduled the Callback</td>
162+
</tr>
163+
<tr>
164+
<td>`target_agent_fullname`</td>
165+
<td>Full name of the agent who contact (and all contact’s tasks) are assigned to</td>
166+
</tr>
167+
<tr>
168+
<td>`target_agent_id`</td>
169+
<td>Email of the agent who contact (and all contact’s tasks) are assigned to</td>
170+
</tr>
171+
<tr>
172+
<td>`task_id`</td>
173+
<td>Unique identifier for the task. Will match the call_id or sms_conversation_id of a completed task event.</td>
174+
</tr>
175+
<tr>
176+
<td>`type`</td>
177+
<td>Task Type</td>
178+
</tr>
179+
<tr>
180+
<td>`call_id`</td>
181+
<td>Task Id for the call</td>
182+
</tr>
183+
<tr>
184+
<td>`disposition`</td>
185+
<td>Task disposition</td>
186+
</tr>
187+
<tr>
188+
<td>`objections`</td>
189+
<td>Task objections</td>
190+
</tr>
191+
<tr>
192+
<td>`notes`</td>
193+
<td>Task notes</td>
194+
</tr>
195+
<tr>
196+
<td>`handle_time`</td>
197+
<td>Full duration task was being handled, including talk time and wrap time (completed_at - started_at)</td>
198+
</tr>
199+
<tr>
200+
<td>`wrapup_time`</td>
201+
<td>Duration task was in wrap up (completed_at - ended_at)</td>
202+
</tr>
203+
<tr>
204+
<td>`talk_time`</td>
205+
<td>Duration of conversation (ended_at - started_at)</td>
206+
</tr>
207+
<tr>
208+
<td>`started_at`</td>
209+
<td>UTC timestamp when the conversation was started</td>
210+
</tr>
211+
<tr>
212+
<td>`ended_at`</td>
213+
<td>UTC timestamp when the conversation was ended</td>
214+
</tr>
215+
<tr>
216+
<td>`completed_at`</td>
217+
<td>UTC Timestamp when the task was completed</td>
127218
</tr>
128219
</table>
129220

src/personas/identity-resolution/use-cases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If a company needs to understand a user's activity across all apps, we recommend
2727

2828
If, however, each app should maintain its own metrics and LTV analysis, regardless of the overlap of users between apps, we recommend creating a separate Personas space per app and only connecting sources related to each app to its space. This will give a siloed view of how users interact with each individual app.
2929

30-
_Note: Each workspace has two spaces by default. contact your CSM to enable additional spaces._
30+
_Note: Each workspace has two spaces by default. Contact your CSM to enable additional spaces._
3131

3232
For an eCommerce example, see [here](/docs/personas/identity-resolution/ecommerce-example/)
3333

0 commit comments

Comments
 (0)