You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/appcues/index.md
+28-22Lines changed: 28 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,39 +3,37 @@ rewrite: true
3
3
title: Appcues Destination
4
4
hide-cmodes: true
5
5
---
6
-
[Appcues](https://www.appcues.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) adds an experience layer to your product, so you can build user onboarding, NPS surveys, or feature announcements in minutes instead of in weeks. The Appcues JavaScript Destination is open-source. You can browse the code [on GitHub](https://github.com/appcues/analytics.js-integration-appcues).
7
-
8
-
If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact)!
6
+
[Appcues](https://www.appcues.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) adds an experience layer to your product so you can build user onboarding, NPS surveys, or feature announcements in minutes instead of weeks. The Appcues JavaScript Destination is open-source. You can browse the code [on GitHub](https://github.com/appcues/analytics.js-integration-appcues).
9
7
10
8
11
9
## Getting Started
12
10
13
11
1. From the Segment web app, click **Catalog**.
14
-
2. Search for "Appcues" in the Catalog, select it, and choose which of your sources to connect the destination to.
12
+
2. Search for "Appcues" in the Catalog, select it, and choose the source you'll connect to the destination.
15
13
3. In the destination settings, enter your `Appcues Id` (for client-side integration functionality) and/or your `API Key` (for server-side integration functionality) from the [Appcues account page](https://my.appcues.com/account).
16
14
17
15
### Server
18
16
19
-
Although our JavaScript destination is the traditional way to use Appcues as part of the Segment platform, Appcues also offers a server-side destination with Segment, which is useful if you'd like to send user profile or event data to Appcues from another Segment partner service. The server-side destination may be used simultaneously with the JS destination. In many cases, this is preferable to routing all data through the JS destination.
17
+
As an alternative to a traditional JavaScript implementation, Appcues offers a server-side destination with Segment.
18
+
19
+
You may find the server-side destination useful if you'd like to send user profile or event data to Appcues from another Segment partner service. You can use the server-side destination alongside the JavaScript destination, which you may find preferable to routing all data through the JavaScript destination.
20
20
21
-
The user profile and event data received through Appcues' server-side Segment destination can be used to segment
22
-
and target Appcues flows, just like data received from the JS destination.
21
+
As with the JavaScript destination, you can segment and target user profile and event data received through the Appcues server-side Segment destination.
23
22
24
-
For example, using the server-side destination, customer profile and event data could be directed from a CRM tool into the Appcues platform. This data could then be used for content targeting and user segmentation in the Appcues content editor, alongside data from our`analytics.js` destination.
23
+
For example, using the server-side destination, you can direct customer profile and event data from a CRM tool into Appcues. You can then use the directed data for content targeting and user segmentation in the Appcues content editor, alongside data from Segment's`analytics.js` destination.
25
24
26
25
## Page
27
26
28
-
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like:
27
+
Refer to the Segment Spec for information about the [Page method](/docs/connections/spec/page/). The following represents an example `page` call:
29
28
30
29
```javascript
31
30
analytics.page();
32
31
```
33
-
34
-
Appcues will check to see if a user qualifies for an experience every time the page changes. When you first call `page` using `analytics.js`, `Appcues.start` checks if there are any current flows for the user and loads them if necessary.
32
+
Each time the page changes, Appcues checks to see if a user qualifies for an experience. When you first call `page` using Analytics.js, `Appcues.start` checks if there are any current flows for the user and loads them, if necessary.
35
33
36
34
## Identify
37
35
38
-
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
36
+
Refer to the Segment Spec for information about the [Identify method](/docs/connections/spec/identify/). The following represents an example `identify` call:
When you `identify`on `analytics.js`, we call`Appcues.identify`. This is the preferred method of using and targeting on user properties.
45
+
When you call `identify`with Analytics.js, Segment calls`Appcues.identify`. This is the preferred method of using and targeting on user properties.
48
46
49
-
To get the most out of Appcues, you should send as much user data as possible in the `identify` call. Properties are used to target experiences to specific users and personalize content. Most Appcues customers send properties that fall into a few groups:
50
-
* Properties to target based on broad classifications such as `role` or `userType`
51
-
* Properties to personalize Appcues content such as `name`, `firstName` or `company`
52
-
* Properties to target based on user lifecycle such as `createdAt` (date) or usage metrics such as `numTasksComplete`
47
+
To get the most out of Appcues, you should send as much user data as possible in the `identify` call. Properties personalize content and target experiences to specific users. Most Appcues customers send properties that fall into one of the following groups:
48
+
* Properties to target based on broad classifications, such as `role` or `userType`
49
+
* Properties to personalize Appcues content, such as `name`, `firstName`, or `company`
50
+
* Properties to target based on user lifecycle, such as `createdAt` (date), or usage metrics, such as `numTasksComplete`
53
51
54
52
## Track
55
53
56
-
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
54
+
Refer to the Segment Spec for information about the [Track method](/docs/connections/spec/track/). The following represents an example `track` call:
57
55
58
56
```javascript
59
57
analytics.track("step_activated", {
60
58
property:"test"
61
59
});
62
60
```
63
61
64
-
Calls to `analytics.track` invoke `Appcues.track` as well. This will send event data to the Appcues platform, where it can be used for future content triggering.
62
+
Calls to `analytics.track`also invoke `Appcues.track`. As a result, the call sends event data to Appcues, where you can use it for future content triggering.
65
63
66
64
### Sending Appcues events to other Segment partner services
67
65
68
-
Want to read Appcues events in your 3rd party analytics or marketing automation tool? Appcues supports sending events to other tools on the Segment platform. These events will be sent as track calls to the other destinations you've turned on. A partial list of Appcues content lifecycle events that can be tracked:
66
+
Appcues supports sending events to other tools on the Segment platform. This capability allows you to read Appcues events in your third-party analytics or marketing automation tools.
67
+
68
+
These events are sent as track calls to the other destinations you've turned on. The following shows a partial list of trackable Appcues content lifecycle events:
69
69
*`flow_shown`
70
70
*`flow_skipped`
71
71
*`flow_finished`
@@ -81,11 +81,17 @@ Want to read Appcues events in your 3rd party analytics or marketing automation
81
81
82
82
To enable this feature, go to the Integrations Settings in Appcues and click "Activate" under the Segment integration.
83
83
84
+
After you activate the Segment integration, Appcues forwards these events to your Segment workspace. The events will appear in the same [Source Debugger](/docs/connections/sources/debugger/).
85
+
84
86
### Whitelisted Domains
85
87
86
-
By default, Appcues will target based on the path of the URL. So if we created an Appcues experience and targeted it to `/integrations`, it would appear wherever the embed script is installed with that URL path, like appcues.com/integrations and my.appcues.com/integrations. If your `analytics.js` script is installed on multiple domains (e.g. your marketing site and your web app), you should use Appcues whitelisted domains when targeting your experience.
88
+
By default, Appcues targets based on the URL's path.
89
+
90
+
For example, if you create an Appcues experience and target it to `/integrations`, it appears wherever the embed script is installed with that URL path, like `appcues.com/integrations` and `my.appcues.com/integrations`.
91
+
92
+
If you've installed the Analytics.js script on multiple domains (like a marketing site and your web app), you should use Appcues-whitelisted domains when targeting your experience.
87
93
88
94
89
95
## Delete
90
96
91
-
When you trigger a user deletion using our [Privacy features](/docs/privacy/user-deletion-and-suppression/), we will forward a delete notification to Appcues, who will act on the notification. You can read more about how Appcues handles deletion requests[in their docs here.](https://docs.appcues.com/article/443-gdpr-deletion-api)
97
+
When you trigger a user deletion using [Segment's Privacy features](/docs/privacy/user-deletion-and-suppression/), Segment forwards an actionable delete notification to Appcues. Refer to the Appcues documentation for information on [how Appcues handles deletion requests](https://docs.appcues.com/article/443-gdpr-deletion-api){:target="_blank"}.
0 commit comments