title: Userpilot Cloud (Actions) Destination

id: 647f30a35eedd03afde0a1c3

beta: true

{% include content/plan-grid.md name="actions" %}

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, which allows you to create more personalized experiences for your users.

This destination is maintained by Userpilot. For any issues with the destination, [contact Userpilot's Support team](mailto:[email protected]){:target="_blank"}.

1. From the Segment web app, click **Catalog**, then click **Destinations**.

2. Find the Destinations Actions item in the left navigation, and click it.

3. Click **Configure Userpilot Cloud (Actions)**.

4. Select an existing Source to connect to Userpilot Cloud (Actions).

5. Find your Userpilot API key and API endpoint in the [environment dashboard](https://run.userpilot.io/environment){:target="_blank"}.

The Userpilot cloud-mode destination uses [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 lets you use Userpilot’s capabilities based on the real-time data received from your application.

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

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

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.

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.

{% include components/actions-fields.html %}

If you experience any issues while setting up Userpilot as a destination, follow these steps:

- Check your Userpilot API Key. Make sure it's correctly entered in Segment.

- Verify that you've enabled Userpilot as a destination in Segment.

- If you're still having trouble, [contact Segment's support team](https://segment.com/help/contact/){:target="_blank"} for further assistance.

title: Userpilot Web (Actions) Destination

id: 6480b4eeab29eca5415089d4

beta: true

{% include content/plan-grid.md name="actions" %}

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, which allows you to create more personalized experiences for your users.

This destination is maintained by Userpilot. For any issues with the destination, [contact Userpilot's Support team](mailto:[email protected]){:target="_blank"}.

{% include content/ajs-upgrade.md %}

1. From the Segment web app, click **Catalog**, then click **Destinations**.

2. Find the Destinations Actions item in the left navigation, and click it.

3. Click **Configure Userpilot Web (Actions)**.

4. Select an existing Source to connect to Userpilot Web (Actions).

5. Find your Userpilot App Token in the [installation dashboard](https://run.userpilot.io/installation){:target="_blank"}.

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:

analytics.page()

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.

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:

analytics.identify('userId123', {

email: '[email protected]'

});

Calling `identify` from `analytics.js` 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

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:

analytics.track('Clicked Login Button')

Calling `track` from `analytics.js` will trigger `userpilot.track`. This sends event data to Userpilot where it can be used for content triggering.