Userpilot Beta
4 minute read
Userpilot is a no-code product experience platform that helps you enhance the user onboarding experience. It allows you to drive user activation, boost feature adoption, and improve user retention through personalized in-app experiences.
Find the open source transformer code for this destination in the GitHub repository.
This integration is built by the Userpilot team. Contact their Support team for any assistance.
Connection compatibility
| Destination Information | |||
|---|---|---|---|
| |||
| Supported sources |  |  | | | | | | |
| Web | | | | | | | | |
In the web device mode integration, that is, using JavaScript SDK as a source, the Userpilot native SDK is loaded from the
https://js.userpilot.io/domain.Based on your website’s content security policy, you might need to allowlist this domain to load the Userpilot SDK successfully.
Get started
Once you have confirmed that the platform supports sending events to Userpilot, follow these steps:
- From your RudderStack dashboard, add the source. Then, from the list of destinations, select Userpilot.
- Assign a name to your destination and click Continue.
Connection settings
| Setting | Description |
|---|---|
| App Token | Enter your Userpilot app token. This token is required to send events to Userpilot in device mode. You can obtain the app token by going to Configure > Environment in your Userpilot dashboard. |
| JS SDK Endpoint | Specify the custom endpoint URL for hosting the Userpilot JavaScript SDK. Note that:
|
| API Key | Enter your Userpilot API key. This token is required to send events to Userpilot in cloud mode. You can obtain the app token by going to Configure > Environment in your Userpilot dashboard. |
| HTTP API Endpoint | Specify the endpoint for the HTTP API. By default, it is set to https://analytex.userpilot.io.Note that:
|
Configuration settings
| Setting | Description |
|---|---|
| Consent settings | Configure the consent management settings for the specified source by choosing the Consent management provider from the dropdown and entering the relevant consent category IDs. See Consent Management in RudderStack for more information on this feature. |
Identify
The identify event lets you identify a user in Userpilot and associate them with their traits.
A sample identify call is shown below:
rudderanalytics.identify("1hKOmRA4GRlmr123", {
name: "Alex Keener",
email: "alex@example.com",
company: {
id: "company123", // Mandatory if the `company` object is passed
... // Other company properties.
},
plan: "Enterprise",
role: "Admin",
createdAt: "2020-01-01T00:00:00.000Z"
});Theidproperty is mandatory if you pass thecompanyobject in youridentifycall.
Track
The track event lets you track user events and send them to Userpilot.
When you make a track call, RudderStack sends the event to Userpilot as a custom event with the event properties included in the call.
A sample track call is shown below:
rudderanalytics.track("Feature Used", {
featureName: "Dashboard Export",
exportFormat: "CSV",
itemsExported: 42
});Page
RudderStack supports thepageevent only in the web device mode integration.
The page event lets you record page views in your web app. RudderStack then sends a page view event to Userpilot.
A sample page call is shown below:
rudderanalytics.page("Home", {
path: "/home",
url: "https://example.com/home",
title: "Home Page",
referrer: "https://google.com"
});Group
The group event lets you associate users with a specific group, like a company or organization.
When you make a group call, RudderStack sends the group information to Userpilot, which you can use for segmentation and creating targeted experiences.
A sample group call is shown below:
rudderanalytics.group("group123", {
name: "Example Corp",
industry: "Technology",
plan: "Enterprise",
employees: 500,
website: "https://example.com"
});FAQ
Where can I find my Userpilot App Token and API Key?
You can find both Userpilot App Token and API Key by going to Configure > Environment in your Userpilot dashboard.
