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
+26-17Lines changed: 26 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ hide-cmodes: true
5
5
---
6
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).
7
7
8
-
If you notice any gaps, outdated information, or have feedback to improve the documentation, [let us know](https://segment.com/help/contact).
8
+
To contribute to this page, visit [Segment’s documentation repository](https://github.com/segmentio/segment-docs/blob/develop/CONTRIBUTING.md).
9
9
10
10
11
11
## Getting Started
@@ -16,25 +16,26 @@ If you notice any gaps, outdated information, or have feedback to improve the do
16
16
17
17
### Server
18
18
19
-
As an alternative to a traditional JavaScript implementation, Appcues offers a server-side destination with Segment. 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.
19
+
As an alternative to a traditional JavaScript implementation, Appcues offers a server-side destination with Segment.
20
20
21
-
As with the JavaScript destination, you can segment and target user profile and event data received through the Appcues server-side Segment destination.
21
+
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.
22
+
23
+
As with the JavaScript destination, you can segment and target user profile and event data received through the Appcues server-side Segment destination.
22
24
23
25
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.
24
26
25
27
## Page
26
28
27
-
To learn more about efer to the [Page method](/docs/connections/spec/page/) in the Segment Spec. An example call would look like:
29
+
Refer to the Segment Spec for information about the [Page method](/docs/connections/spec/page/). The following represents an example `page` call:
28
30
29
31
```javascript
30
32
analytics.page();
31
33
```
32
-
33
-
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.
34
+
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.
34
35
35
36
## Identify
36
37
37
-
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:
38
+
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.
47
+
When you use `identify` on `analytics.js`, Segment call `Appcues.identify`. This is the preferred method of using and targeting on user properties.
47
48
48
-
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:
49
-
* Properties to target based on broad classifications such as `role` or `userType`
50
-
* Properties to personalize Appcues content such as `name`, `firstName` or `company`
51
-
* Properties to target based on user lifecycle such as `createdAt` (date) or usage metrics such as `numTasksComplete`
49
+
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 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`
52
53
53
54
## Track
54
55
55
-
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:
56
+
Refer to the Segment Spec for information about the [Track method](/docs/connections/spec/track/). The following represents an example `track` call:
56
57
57
58
```javascript
58
59
analytics.track("step_activated", {
59
60
property:"test"
60
61
});
61
62
```
62
63
63
-
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.
64
+
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.
64
65
65
66
### Sending Appcues events to other Segment partner services
66
67
67
-
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:
68
+
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.
69
+
70
+
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:
68
71
*`flow_shown`
69
72
*`flow_skipped`
70
73
*`flow_finished`
@@ -80,11 +83,17 @@ Want to read Appcues events in your 3rd party analytics or marketing automation
80
83
81
84
To enable this feature, go to the Integrations Settings in Appcues and click "Activate" under the Segment integration.
82
85
86
+
After you activate the Segment integration, Appcues automatically forwards these events to your Segment workspace. The events will appear in the same [Source Debugger](/docs/connections/sources/debugger/).
87
+
83
88
### Whitelisted Domains
84
89
85
-
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.
90
+
By default, Appcues targets based on the URL's path.
91
+
92
+
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`.
93
+
94
+
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.
86
95
87
96
88
97
## Delete
89
98
90
-
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)
99
+
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).
0 commit comments