From 4b6134c6e53d38b9b66b873a3515d1682f21f8b3 Mon Sep 17 00:00:00 2001 From: motasem-userpilot Date: Mon, 28 Jul 2025 15:56:18 +0300 Subject: [PATCH 1/4] Userpilot mobile destination --- .../catalog/userpilot-mobile/index.md | 83 +++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 src/connections/destinations/catalog/userpilot-mobile/index.md diff --git a/src/connections/destinations/catalog/userpilot-mobile/index.md b/src/connections/destinations/catalog/userpilot-mobile/index.md new file mode 100644 index 0000000000..6f33df12b3 --- /dev/null +++ b/src/connections/destinations/catalog/userpilot-mobile/index.md @@ -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. + +[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:support@userpilot.com). + +## 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)". +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: "", traits: [ + "email": "john.doe@example.com", + "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. + +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 + +These appear within the Userpilot user dashboard and power audience segmentation and targeting. + + +### Group +Send [Group](/docs/connections/spec/group) calls to associate users with an account, organization, or project. + +```swift +analytics.group(groupId: "", 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) +* Monitor user behavior for analytics or lifecycle targeting \ No newline at end of file From 7b659ca14c9137866a8a44ef4ced298fc0ef6c80 Mon Sep 17 00:00:00 2001 From: motasem-userpilot Date: Thu, 31 Jul 2025 09:37:09 +0300 Subject: [PATCH 2/4] =?UTF-8?q?=F0=9F=93=9D=20Update=20index.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../catalog/userpilot-mobile/index.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/src/connections/destinations/catalog/userpilot-mobile/index.md b/src/connections/destinations/catalog/userpilot-mobile/index.md index 6f33df12b3..068b5d1b7f 100644 --- a/src/connections/destinations/catalog/userpilot-mobile/index.md +++ b/src/connections/destinations/catalog/userpilot-mobile/index.md @@ -2,15 +2,15 @@ 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. +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, enabling you to create more personalized experiences for your users across the product lifecycle. [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:support@userpilot.com). +Userpilot maintains this destination. For any issues with the destination, [contact the Userpilot Support team](mailto:support@userpilot.com). ## 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)". +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)*. 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**. @@ -29,19 +29,18 @@ analytics.identify(userId: "", traits: [ "email": "john.doe@example.com", "name": "John Doe", "plan": "Pro", - "createdAt": "2023-08-01T00:00:00Z" + "createdAt": "2019-10-17" ]) ``` -Calling `identify` from `Segment` will trigger the `userpilot.identify`. Segment recommends passing as much data as possible to get the most out of Userpilot. +Calling Identify from Segment triggers `userpilot.identify`. Segment recommends passing as much data as possible to get the most out of Userpilot. -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 +Data passed in an Identify call can be organized under these different categories: +* Properties about the user such as `plan` or `userRole` help target a specific 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 - -These appear within the Userpilot user dashboard and power audience segmentation and targeting. +* 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 lifecycle +These appear within Userpilot's user dashboard and power audience segmentation and targeting. ### Group Send [Group](/docs/connections/spec/group) calls to associate users with an account, organization, or project. @@ -53,7 +52,7 @@ analytics.group(groupId: "", traits: [ ]) ``` -Segment sends Group calls to Userpilot as a `userpilot.identify` update with company-level traits, allowing you to use company metadata in targeting logic. +Calling Group from Segment triggers `userpilot.identify` with company-level traits, allowing you to use company metadata in targeting logic. ### Screen @@ -63,7 +62,7 @@ Send [Screen](/docs/connections/spec/screen) calls to track navigation or screen analytics.screen(title: "Home") ``` -Segment sends Screen calls to Userpilot as a `userpilot.screen` event. This allows Userpilot to: +Calling Screen from Segment triggers `userpilot.screen` event. This allows Userpilot to: * Trigger relevant experiences configured for specific pages/screens. * Check for ongoing experiences already running. @@ -73,11 +72,12 @@ Segment sends Screen calls to Userpilot as a `userpilot.screen` event. This allo Send [Track](/docs/connections/spec/track) calls to log user actions or custom events. ```swift -analytics.track(name: "Button Clicked", properties: [ - "buttonColor": "green" +analytics.track(name: "Added to Cart", properties: [ + "itemId" : "sku_456", + "price" : 29.99 ]) ``` -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) +Calling Track from Segment triggers `userpilot.track`. These custom events can be used to: +* Trigger specific experiences (for example, a Carousel or Survey) * Monitor user behavior for analytics or lifecycle targeting \ No newline at end of file From 7da05d298483533b8d6fe3b34071304cb1ce8cbf Mon Sep 17 00:00:00 2001 From: motasem-userpilot Date: Mon, 4 Aug 2025 15:09:46 +0300 Subject: [PATCH 3/4] =?UTF-8?q?=F0=9F=93=9D=20Add=20Segment=20Destination?= =?UTF-8?q?=20ID?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/connections/destinations/catalog/userpilot-mobile/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/connections/destinations/catalog/userpilot-mobile/index.md b/src/connections/destinations/catalog/userpilot-mobile/index.md index 068b5d1b7f..2b80633eb0 100644 --- a/src/connections/destinations/catalog/userpilot-mobile/index.md +++ b/src/connections/destinations/catalog/userpilot-mobile/index.md @@ -1,5 +1,6 @@ --- title: Userpilot Mobile (Device Mode) Destination +id: 68207e064c022255721ec2d3 --- 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, enabling you to create more personalized experiences for your users across the product lifecycle. From 9f87520ee0f8e09045b00a766ea16ae9b3f688de Mon Sep 17 00:00:00 2001 From: Motasem Date: Wed, 6 Aug 2025 09:09:24 +0300 Subject: [PATCH 4/4] Update index.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- src/connections/destinations/catalog/userpilot-mobile/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/userpilot-mobile/index.md b/src/connections/destinations/catalog/userpilot-mobile/index.md index 2b80633eb0..f661459c67 100644 --- a/src/connections/destinations/catalog/userpilot-mobile/index.md +++ b/src/connections/destinations/catalog/userpilot-mobile/index.md @@ -1,5 +1,5 @@ --- -title: Userpilot Mobile (Device Mode) Destination +title: Userpilot Mobile Device Mode Destination id: 68207e064c022255721ec2d3 ---