-
Notifications
You must be signed in to change notification settings - Fork 381
Userpilot mobile destination #7800
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
83 changes: 83 additions & 0 deletions
83
src/connections/destinations/catalog/userpilot-mobile/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
--- | ||
title: Userpilot Mobile (Device Mode) Destination | ||
--- | ||
|
||
Userpilot helps product teams deliver personalized in-app experiences to increase growth metrics at every stage of the user journey. When you integrate Userpilot with Segment, you can send your Segment events to Userpilot, allowing you to create more personalized experiences for your users across the product lifecycle. | ||
motasem-userpilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
[Userpilot](https://www.userpilot.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} provides in-app guidance, product tours, and contextual onboarding experiences to help teams activate users and drive feature adoption. | ||
|
||
This destination is maintained by Userpilot. For any issues with the destination, [contact the Userpilot Support team](mailto:[email protected]). | ||
motasem-userpilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Getting started | ||
|
||
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"}, search for "Userpilot Mobile (Device Mode)". | ||
motasem-userpilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
2. Select **Userpilot Mobile** and click **Add Destination**. | ||
3. Select an existing Source to connect to Userpilot. | ||
4. Go to the [Userpilot installation dashboard](https://run.userpilot.io/installation){:target="_blank"}, and copy your **App Token**. | ||
5. Enter the **App Token** in the Userpilot destination settings in Segment. | ||
|
||
## Supported methods | ||
|
||
Userpilot supports the following methods, as specified in the [Segment Spec](/docs/connections/spec). | ||
|
||
### Identify | ||
|
||
Send [Identify](/docs/connections/spec/identify) calls to associate a user with traits. These are used for segmentation, personalization, and lifecycle targeting. | ||
|
||
```swift | ||
analytics.identify(userId: "<USER_ID>", traits: [ | ||
"email": "[email protected]", | ||
"name": "John Doe", | ||
"plan": "Pro", | ||
"createdAt": "2023-08-01T00:00:00Z" | ||
]) | ||
``` | ||
|
||
Calling `identify` from `Segment` will trigger the `userpilot.identify`. Segment recommends passing as much data as possible to get the most out of Userpilot. | ||
motasem-userpilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Data passed in an Identify call can be organized under different categories. | ||
* Properties about the user such as `plan` or `userRole` to help targeting a specifc segment | ||
* Properties to personalize the content of the Userpilot experiences, such as `name` or `company` | ||
* Properties to target users based on their lifecycle, such as `createdAt`, which allows you to target newly created accounts or accounts that have yet to achieve a certain feature in the user lifecyle | ||
motasem-userpilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
These appear within the Userpilot user dashboard and power audience segmentation and targeting. | ||
motasem-userpilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
### Group | ||
Send [Group](/docs/connections/spec/group) calls to associate users with an account, organization, or project. | ||
|
||
```swift | ||
analytics.group(groupId: "<GROUP_ID>", traits: [ | ||
"companyName": "Acme Inc.", | ||
"subscriptionTier": "Enterprise" | ||
]) | ||
``` | ||
|
||
Segment sends Group calls to Userpilot as a `userpilot.identify` update with company-level traits, allowing you to use company metadata in targeting logic. | ||
|
||
|
||
### Screen | ||
Send [Screen](/docs/connections/spec/screen) calls to track navigation or screen changes in mobile apps. | ||
|
||
```swift | ||
analytics.screen(title: "Home") | ||
``` | ||
|
||
Segment sends Screen calls to Userpilot as a `userpilot.screen` event. This allows Userpilot to: | ||
* Trigger relevant experiences configured for specific pages/screens. | ||
* Check for ongoing experiences already running. | ||
|
||
|
||
### Track | ||
|
||
Send [Track](/docs/connections/spec/track) calls to log user actions or custom events. | ||
|
||
```swift | ||
analytics.track(name: "Button Clicked", properties: [ | ||
"buttonColor": "green" | ||
]) | ||
``` | ||
|
||
Segment sends Track calls to Userpilot as `userpilot.track`. These custom events can be used to: | ||
* Trigger specific experiences (e.g., a Caroucel or Survey) | ||
motasem-userpilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* Monitor user behavior for analytics or lifecycle targeting |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.