# Inleads AI Destination

## Destination Info

* Accepts [Page](/docs/segment/connections/spec/page), [Alias](/docs/segment/connections/spec/alias), [Group](/docs/segment/connections/spec/group), [Identify](/docs/segment/connections/spec/identify), [Track](/docs/segment/connections/spec/track) calls.
* Refer to it as **Inleads AI** in the [Integrations object.](/docs/segment/guides/filtering-data/#filtering-with-the-integrations-object)
* This integration is **partner owned.** Please reach out to the partner's support for any issues.

[Inleads.ai](http://Inleads.ai?utm_source=segmentio\&utm_medium=docs\&utm_campaign=partners) is an AI-driven sales intelligence and analytics platform designed to empower startups and enterprises with comprehensive tools for growth.

Using Inleads, you can gain deeper insights into your customer journey and drive smarter decisions with the Inleads.ai and Segment integration. With this integration, seamlessly map Segment events to Inleads.ai events, enabling you to track deals, leads and customer activities across every touchpoint. Dive into real-time sales, product, and revenue insights, powered by advanced analytics and machine learning algorithms. With Inleads.ai and Segment, unlock the full potential of your customer data to fuel your business success.

This destination is maintained by [Inleads.ai](http://Inleads.ai?utm_source=segmentio\&utm_medium=docs\&utm_campaign=partners). For any issues with the destination, [contact the Inleads Support team](mailto:info@inleads.ai).

## Getting Started

1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for **Inleads** in the Destinations Catalog, and select the **Inleads** destination.
3. Choose which Source should send data to the Inleads destination.
4. Go to the [Inleads dashboard](https://app.inleads.ai/#/settings) and find the **API Key** in Settings API Keys tab.
5. Enter the **API Key** in the Inleads destination settings in Segment.

## Supported methods

Inleads supports the following methods, as specified in the [Segment Spec](/docs/segment/connections/spec).

### Identify

Send [Identify](/docs/segment/connections/spec/identify) calls to create new user profile or update existing users with new trait values. For example:

```js
analytics.identify("inleadsUser123", {
  email: "test@example.com",
});
```

Segment sends Identify calls to Inleads as an `identify` event.

### Track

Send [Track](/docs/segment/connections/spec/track) calls to record user behavior in your app. For example:

```js
analytics.track("New lead created");
```

Segment sends Track calls to Inleads as a `track` event.

### Group

Send [Group](/docs/segment/connections/spec/group) calls to associate an individual user to group. For example:

```js
analytics.group("0e8c78ea9d97a7b8185e8632", {
  name: "Initech",
  industry: "Technology",
  employees: 329,
  plan: "enterprise",
  "total billed": 830
});
```

## Destination Settings

| Field   | Description                                                                     | Required | Type   |
| ------- | ------------------------------------------------------------------------------- | -------- | ------ |
| API Key | Your Inleads AI API Key. You can find your API Key in your inleads.ai settings. | Yes      | string |

## Available Presets

Inleads AI has the following presets

| Preset Name   | Trigger                 | Default Action |
| ------------- | ----------------------- | -------------- |
| Track Event   | Event type = "track"    | Track          |
| Group         | Event type = "group"    | Group          |
| Identify User | Event type = "identify" | Identify       |

## Available Actions

Build your own Mappings. Combine supported [triggers](/docs/segment/connections/destinations/actions/#components-of-a-destination-action) with the following Inleads AI-supported actions:

> \[!NOTE]
>
> Individual destination instances have support a maximum of 50 mappings.

* [Group](#group-2)
* [Track](#track-1)
* [Identify](#identify-2)

### Group

Send group calls to Inleads AI.

Group is a **Cloud** action. The default Trigger is `type = "group"`

| Field              | Description                                                                                                                | Required | Type   |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------- | -------- | ------ |
| Account id         | The External ID of the account to send properties for                                                                      | Yes      | STRING |
| User ID            | The ID associated with the user                                                                                            | No       | STRING |
| Account name       | The Account name                                                                                                           | Yes      | STRING |
| Account created at | The timestamp when the account was created, represented in the ISO-8601 date format. For instance, "2023-09-26T15:30:00Z". | No       | STRING |
| Account properties | The properties of the account                                                                                              | No       | OBJECT |
| Account website    | The account website                                                                                                        | No       | STRING |
| User Metadata      | User metadata including IP, Location, etc.                                                                                 | No       | OBJECT |
| Anonymous ID       | User Anonymous id                                                                                                          | No       | STRING |
| Event ID           | The ID of the event.                                                                                                       | No       | STRING |
| URL                | The URL of the page where the event occurred.                                                                              | No       | STRING |
| Referrer           | The referrer of the page where the event occurred.                                                                         | No       | STRING |
| User Language      | The language of the browser.                                                                                               | No       | STRING |
| UTC Time           | The time of the event in UTC.                                                                                              | Yes      | STRING |
| UTM                | Information about the UTM parameters.                                                                                      | No       | OBJECT |
| Screen             | Information about the screen.                                                                                              | No       | OBJECT |
| Timezone           | The timezone of the browser.                                                                                               | No       | STRING |
| IP Address         | The IP address of the user.                                                                                                | No       | STRING |

### Track

Send track calls to Inleads AI.

Track is a **Cloud** action. The default Trigger is `type = "track"`

| Field            | Description                                                               | Required | Type   |
| ---------------- | ------------------------------------------------------------------------- | -------- | ------ |
| Event name       | The name of the event                                                     | Yes      | STRING |
| User id          | The user id, to uniquely identify the user associated with the event      | Yes      | STRING |
| Account id       | The account id, to uniquely identify the account associated with the user | No       | STRING |
| Event properties | The properties of the track call                                          | No       | OBJECT |
| Event Traits     | The Traits of the track call                                              | No       | OBJECT |
| User Metadata    | User metadata including IP, Location, etc.                                | No       | OBJECT |
| Anonymous ID     | User Anonymous id                                                         | No       | STRING |
| Event ID         | The ID of the event.                                                      | No       | STRING |
| URL              | The URL of the page where the event occurred.                             | No       | STRING |
| Referrer         | The referrer of the page where the event occurred.                        | No       | STRING |
| User Language    | The language of the browser.                                              | No       | STRING |
| UTC Time         | The time of the event in UTC.                                             | Yes      | STRING |
| UTM              | Information about the UTM parameters.                                     | No       | OBJECT |
| Screen           | Information about the screen.                                             | No       | OBJECT |
| Timezone         | The timezone of the browser.                                              | No       | STRING |
| IP Address       | The IP address of the user.                                               | No       | STRING |

### Identify

Send identify calls to Inleads AI.

Identify is a **Cloud** action. The default Trigger is `type = "identify"`

| Field         | Description                                                                                                             | Required | Type   |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- | -------- | ------ |
| User ID       | The External ID of the user                                                                                             | Yes      | STRING |
| Name          | The user's name                                                                                                         | No       | STRING |
| First name    | The user's first name. This field is mandatory if you're not providing a name field                                     | No       | STRING |
| Last name     | The user's last name. This field is mandatory if you're not providing a name field                                      | No       | STRING |
| Email address | The user's email address                                                                                                | No       | STRING |
| Account id    | The account id, to uniquely identify the account associated with the user                                               | No       | STRING |
| Created at    | The timestamp when the user was created, represented in the ISO-8601 date format. For instance, "2023-09-26T15:30:00Z". | No       | STRING |
| Traits        | Properties to associate with the user                                                                                   | No       | OBJECT |
| User Metadata | User metadata including IP, Location, etc.                                                                              | No       | OBJECT |
| Anonymous ID  | User Anonymous id                                                                                                       | No       | STRING |
| Event ID      | The ID of the event.                                                                                                    | No       | STRING |
| URL           | The URL of the page where the event occurred.                                                                           | No       | STRING |
| Referrer      | The referrer of the page where the event occurred.                                                                      | No       | STRING |
| User Language | The language of the browser.                                                                                            | No       | STRING |
| UTC Time      | The time of the event in UTC.                                                                                           | Yes      | STRING |
| UTM           | Information about the UTM parameters.                                                                                   | No       | OBJECT |
| Screen        | Information about the screen.                                                                                           | No       | OBJECT |
| Timezone      | The timezone of the browser.                                                                                            | No       | STRING |
| IP Address    | The IP address of the user.                                                                                             | No       | STRING |

## Engage

You can send computed traits and audiences generated using [Engage](/docs/segment/engage) to this destination as a **user property**. To learn more about Engage, schedule a [demo](https://segment.com/contact/demo).

For user-property destinations, an [identify](/docs/segment/connections/spec/identify/) call is sent to the destination for each user being added and removed. The property name is the snake\_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property `order_completed_last_30days: true`. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to `false`.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

> \[!NOTE]
>
> Real-time audience syncs to Inleads AI  may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.

## Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

| Field   | Description                                                                     | Required | Type   |
| ------- | ------------------------------------------------------------------------------- | -------- | ------ |
| API Key | Your Inleads AI API Key. You can find your API Key in your inleads.ai settings. | Yes      | string |
