is a popular marketing automation platform. It provides robust tools for the marketing, sales, management, and support teams to boost their brand value, enhance customer engagement, and increase conversions.

RudderStack supports as a destination where you can seamlessly send your event data.

Getting started

Before configuring as a destination in RudderStack, verify if the source platform is supported by by referring to the table below:

Connection ModeWebMobileServer
Device mode---
Cloud modeSupportedSupportedSupported
To know more about the difference between cloud mode and device mode in RudderStack, refer to the RudderStack Connection Modes guide.

Once you have confirmed that the source platform supports sending events to, follow these steps:

  1. From your RudderStack dashboard, add a source. Then, from the list of destinations, select
  2. Assign a name to the destination and click Continue.

Connection settings

To successfully configure as a destination, you will need to configure the following settings: connection settings connection settings connection settings
  • Public REST API Key: Enter your public REST API key.
  • App Subdomain: Enter the subdomain of your app.
For more information on obtaining the public REST API key and app subdomain, refer to the FAQ section below.
  • Map Rudder user attributes to attributes: With this setting, you can map the RudderStack user attributes to specific user attributes.
  • Map RudderStack event name to event name: Use this setting to map the RudderStack event names to specific events. You can map one or more RudderStack events to a single event but not vice-versa.
  • Map your event property: Enter the RudderStack and event properties you want to map for the above-mentioned event names. You can map a RudderStack property only to one property and vice-versa.
  • Map Rudder company attributes to company attributes: Use this setting to map the RudderStack company attributes to specific company attributes.

User lookup

This functionality is applicable only for the identify, track, and page calls.

RudderStack looks up a user in using the user_key, email, or phone properties.

  • You can pass the user_key in the externalId array, as shown:
"externalId": [{
"type": "userKey",
"id": "uehfuuiuednjk"
  • You can pass the email or phone in the integrations object, as shown:
integrations: {
user: {
lookup: "email/phone"
You must pass only one of email or phone in lookup. Also, email or phone (whichever is passed) must have unique values in

The precedence order for looking up a user based on the above properties is:

  • The userKey is given the highest priority.
  • The lookup value is given the second highest priority. If phone/email (whichever is passed) is not found, RudderStack will throw an error.
  • If none of the above is present, RudderStack falls back to the userId. If not found, RudderStack will throw an error.


You can use the identify call to create a new user in If the user already exists, RudderStack updates the user details.

A sample identify call is shown below:

rudderanalytics.identify('1hKOmRA4el9Zt1WSfVJIVo4GRlm', {
firstName: 'Alex',
lastName: 'Keener',
email: ""
}, {
externalId: [{
type: "userKey",
id: "Df344sdFgdDsS4"
integrations: {
user: {
lookup: "email"

Property mapping

The following table lists the mappings between RudderStack and properties for identify call:

RudderStack propertyPresence


You can use the track call to record a new event which, in turn, can be used to filter and bucket users in

A sample track call is shown below:

rudderanalytics.track('Add to cart', {
purchased_item: "T-Shirt",
brand: "Zara",
email: ""
}, {
integrations: {
user: {
lookup: "email"

Property mapping

The following table lists the mappings between RudderStack and properties for the track call:

RudderStack propertyPresence


The page call lets you record your website's page views with any additional relevant information about the viewed page.

A sample page call is shown below:"section-name", {
path: "path",
url: "url",
title: "title",
search: "search",
referrer: "referrer",
phone: "1-202-555-0146",
}, {
integrations: {
user: {
lookup: "phone"

Property mapping

The following table lists the mappings between RudderStack and properties for page call:

RudderStack property


You can use the group call to create or update a company profile and associate a user with it.

A sample group call is shown below:
"group01", {
name: "Alex Keener",
phone: "1-202-555-0146",
size: 51,
zipcode: 90009,
street: "6649 N Blue Gum Street",
city: "New Orleans",
region: "Louisiana",
country: "USA"

Property mapping

The following table lists the mappings between RudderStack and properties for the group call:

RudderStack property
traits.namename(company name)Optional


Where can I find the public REST API key?

To get your public REST API key, follow these steps:

  1. Log into your dashboard and go to your app.
  2. Click Settings > App settings > Advanced > Public REST API keys.
  3. Click Create API key, as shown: connection settings

Where can I find the app subdomain?

To get your app subdomain, follow these steps:

  1. Log into your dashboard and go to your app.
  2. Click Settings > Setup & Integrations to see the app domain. The subdomain is the part of the complete domain excluding, as shown: connection settings

Contact us

For more information on the topics covered on this page, email us or start a conversation in our Slack community.

On this page