# Userlist

[Userlist](https://userlist.com) is a popular behavior-based messaging platform that lets you engage with your SaaS users effectively through targeted, behavior-based campaigns.

RudderStack supports sending your events to Userlist from the cloud mode S2S (Server to Server) by calling the relevant RudderStack APIs.

{{< success >}}
This destination is supported by the Userlist team. You can contact the Userlist team via <a href="mailto:support@userlist.com">support@userlist.com</a>.
{{< /success >}}

Find the open source transformer code for this destination in the <a href="https://github.com/rudderlabs/rudder-transformer/tree/main/src/v0/destinations/userlist">GitHub repository</a>.

## Connection compatibility

{{< destination-config >}}

## Get started

Once you have confirmed that the platform supports sending events to Userlist, perform the steps below:

- From your [RudderStack dashboard](https://app.rudderlabs.com/), add the source and Userlist as a destination.
- Name your destination, and click **Next**. You should be able to see the following screen:

{{< image src="images/userlist.webp"  >}}
<span class="imageTitle">Connection settings for Userlist destination</span>

- Enter the **Userlist Pus Key** which you can find from your [Userlist Push API settings](https://app.userlist.com/settings/push).
- Once the destination is enabled, events from the RudderStack SDK will start to flow to Userlist.

{{< warning >}}

Userlist does not support tracking of anonymous users. So, make sure you call `identify` before calling `track`.
{{< /warning >}}

## Identify

The [`identify`]({{< ref "event-spec/standard-events/identify.md" >}}) call sends the event data to Userlist along with the properties that you pass as the RudderStack traits.

If the `userId` is already known, Userlist will update the user record. Otherwise, it’ll create a new one.

{{< warning >}}

Userlist will only process messages with a `userId`. Messages with only an `anonymousId` will be ignored.

{{< /warning >}}

The following code snippet is an example of an `identify` call in RudderStack:

```javascript
rudderanalytics.identify("test-user-id", {
  name: "Tintin",
  city: "Brussels",
  country: "Belgium",
  email: "tintin@herge.com",
})
```

## Group

The [`group`]({{< ref "event-spec/standard-events/group.md" >}}) call is made to associate the user with a company in Userlist.

An example of a `group` call is as shown:

```javascript
rudderanalytics.group("test-group-id", {
  name: "Example, Inc.",
  industry: "Testing",
  employees: 42,
})
```

{{< info >}}
Userlist supports adding properties to the relationship between user and group. As this isn't officially supported by RudderStack's message format, you can specify the relationship properties by providing additional data for Userlist specifically.
{{< /info >}}

The following example will associate the currently identified user with the given group (company) and set their `role` for that particular group (company) to `owner`.

```javascript
rudderanalytics.group("test-group-id", {
  name: "Example, Inc.",
  industry: "Testing",
  employees: 42,
  integrations: {
    Userlist: {
      extensions: {
        relationship: {
          properties: {
            role: "owner",
          },
        },
      },
    },
  },
})
```

## Track

The [`track`]({{< ref "event-spec/standard-events/track.md" >}}) call will pass the event properties to Userlist. You may call `rudderanalytics.track()` with or without event properties.

The following code snippet shows how a sample `track` call is made in RudderStack:

```javascript
rudderanalytics.track("Project created", {
  project_name: "Demo Project",
})
```

{{< info >}}

Note that every `track` call will be sent to Userlist as a new event. You may send additional properties to describe the event in more detail.

Both the event name and additional properties will be stored with the event and normalized to snake case \(`project_created` and `project_name`\) automatically within Userlist.

{{< /info >}}

To track an event in the context of a group \(company\), you need to specify the `groupId` in the `context`:

```javascript
rudderanalytics.track("Project created", {
  project_name: "Demo Project",
  context: {
    groupId: "test-group-id",
  },
})
```