Skip to content

Commit 8d4f863

Browse files
committed
userpilot new integration docs
1 parent 4d431b1 commit 8d4f863

File tree

2 files changed

+108
-0
lines changed
  • src/connections/destinations/catalog

2 files changed

+108
-0
lines changed
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
2+
---
3+
title: Userpilot Cloud (Actions) Destination
4+
id: <integration_id>
5+
---
6+
7+
{% include content/plan-grid.md name="actions" %}
8+
9+
Userpilot helps product, UX and customer success teams increase user adoption through behavior-driven product experiences. When you integrate Userpilot with Segment, you can send your Segment events to Userpilot, which allows you to create more personalized experiences for your users.
10+
11+
12+
This destination is maintained by Userpilot. For any issues with the destination, [contact their Support team](mailto:[email protected]).
13+
14+
{% include content/ajs-upgrade.md %}
15+
16+
## Getting started
17+
18+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
19+
2. Find the Destinations Actions item in the left navigation, and click it.
20+
3. Click **Configure Userpilot Cloud (Actions)**.
21+
4. Select an existing Source to connect to Userpilot Cloud (Actions).
22+
5. Find your Userpilot API key and API endpoint in the [environment dashboard](https://run.userpilot.io/environment){:target="_blank"}.
23+
24+
### Overview
25+
26+
The Userpilot cloud mode destination utilizes [Userpilot’s REST APIs](https://docs.userpilot.com/article/195-identify-users-and-track-api){:target="_blank"} to transmit user data and associated events directly to Userpilot. This enables you to leverage Userpilot’s capabilities based on the real-time data received from your application.
27+
28+
- **User Identification** Send [Identify](/docs/connections/spec/identify/) calls from Segment to Userpilot for identifying or updating user and company properties. This data is dispatched directly from your backend servers and can be used for segmenting users and triggering personalized content in real-time
29+
30+
- **Event Tracking:** Segment [Track](/docs/connections/spec/track/) calls are converted into Userpilot events. This feature captures user actions on your web application, allowing you to build a comprehensive understanding of your user's overall experience. You can trigger live, targeted content based on certain user actions like clicking a button or completing a transaction.
31+
32+
33+
It's important to remember that each Identify and Track call is sent to Userpilot’s server directly without being affected by the user’s browser settings. This direct server-to-server communication enables a more reliable and secure data transfer.
34+
35+
Remember to follow Segment’s API rate limits to ensure your data is being sent at an acceptable rate. Always check Userpilot’s API documentation for the most recent information on how to set up Userpilot as a Cloud Mode Destination in Segment.
36+
37+
{% include components/actions-fields.html %}
38+
39+
40+
## Troubleshooting
41+
42+
If you experience any issues while setting up Userpilot as a destination, follow these steps:
43+
44+
- Check your Userpilot API Key. Make sure it's correctly entered in Segment.
45+
- Verify that you've enabled Userpilot as a destination in Segment.
46+
- If you're still having trouble, contact Segment's support team for further assistance.
47+
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
2+
---
3+
title: Userpilot Web (Actions) Destination
4+
id: <integration_id>
5+
---
6+
7+
{% include content/plan-grid.md name="actions" %}
8+
9+
Userpilot helps product, UX and customer success teams increase user adoption through behavior-driven product experiences. When you integrate Userpilot with Segment, you can send your Segment events to Userpilot, which allows you to create more personalized experiences for your users.
10+
11+
12+
This destination is maintained by Userpilot. For any issues with the destination, [contact their Support team](mailto:[email protected]).
13+
14+
{% include content/ajs-upgrade.md %}
15+
16+
17+
## Getting Started
18+
19+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
20+
2. Find the Destinations Actions item in the left navigation, and click it.
21+
3. Click **Configure Userpilot Web (Actions)**.
22+
4. Select an existing Source to connect to Userpilot Web (Actions).
23+
5. Find your Userpilot App Token in the [installation dashboard](https://run.userpilot.io/installation){:target="_blank"}.
24+
25+
26+
## Page
27+
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:
28+
29+
```js
30+
analytics.page()
31+
```
32+
33+
Calling the `page` from `analytics.js` triggers the `userpilot.reload` method that will check for any current running experiences on that page and fetch any new experiences that satisfy the specifed page settings.
34+
35+
## Identify
36+
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+
39+
```js
40+
analytics.identify('userId123', {
41+
42+
});
43+
```
44+
45+
Calling `identify` from `analytics.js` will trigger the `userpilot.identify`. We recommend passing as much data as possible to get the most out of Userpilot.
46+
47+
Data passed in the `identify` can be organized under different categories.
48+
* Properties about the user such as `plan` or `userRole` to help targetting a specifc segment.
49+
* Properties to personalize the content of the Userpilot experiences such as `name` or `company`.
50+
* Properties to target users based on their lifecycle such as `createdAt`. This will allow you to target newly created accounts or accounts that have yet to achieve a certain feature in the user lifecyle.
51+
52+
53+
## Track
54+
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+
57+
```js
58+
analytics.track('Clicked Login Button')
59+
```
60+
61+
Calling `track` from `analytics.js` will trigger `userpilot.track`. This sends event data to Userpilot where it can be used for content triggering.

0 commit comments

Comments
 (0)