|
| 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