# Segment Connections 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 **Segment**, **Segment Connections** in the [Integrations object.](/docs/segment/guides/filtering-data/#filtering-with-the-integrations-object)

The Segment Connections destination lets you mold data extracted from your warehouse into [Segment Spec](/docs/segment/connections/spec/) API calls that can be processed by Segment's Tracking API.

> \[!WARNING]
>
> You can only connect the Segment Connections destination to Reverse ETL warehouse sources.

## Getting started

### Create a source

1. From the Segment web app, navigate to **Sources** and select **Add Source**.
2. Search for **HTTP API** in the Sources Catalog, select the [HTTP API source](/docs/segment/connections/sources/catalog/libraries/server/http-api/), and click **Add Source**.
3. Follow the steps to name your source. This is the source that will receive API calls from the Segment Connections destination.
4. Copy the Write Key on the **Overview** tab. You will need this when you set up the Segment Connections destination.

### Connect and configure the Segment Connections destination

1. From the Segment web app, navigate to **Reverse ETL > Destinations**.
2. Click **Add Destination**.
3. Select the Segment Connections destination, click **Next**, and select the warehouse source that will send data to the Segment Connections destination. If you have not set up a warehouse source, follow the steps in the Reverse ETL documentation on [Getting started](/docs/segment/connections/reverse-etl#getting-started).
4. On the **Settings** tab, name your destination, input the Write Key from the source created above, select an endpoint region, and click **Save Changes**. It is recommended to configure and enable all mappings before enabling the Segment Connections destination.
5. On the **Mappings** tab, click **Add Mapping**. Select a data model and the API call type you want to map. Fill in the fields on screen to create the desired mappings, and click **Create Mapping** to complete the configuration. Repeat this step to configure multiple mappings.
6. Enable the configured mapping(s).
7. On the **Settings** tab, click the **Enable Destination** toggle, and then click **Save Changes** to enable the Segment Connections destination.

## Destination Settings

| Field            | Description                                | Required | Type   |
| ---------------- | ------------------------------------------ | -------- | ------ |
| Source Write Key | The \*\*Write Key\*\* of a Segment source. | Yes      | string |

## Available Actions

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

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

* [Send Page](#send-page)
* [Send Track](#send-track-1)
* [Send Identify](#send-identify-1)
* [Send Group](#send-group-1)
* [Send Screen](#send-screen)

### Send Page

Send a page call to Segment’s tracking API. This is used to track website page views.

Send Page is a **Cloud** action. The default Trigger is `type = "page"`

| Field               | Description                                                                                                                                      | Required | Type   |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------ |
| User ID             | Unique identifier for the user in your database. A userId or an anonymousId is required.                                                         | No       | STRING |
| Anonymous ID        | A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier. A userId or an anonymousId is required. | No       | STRING |
| Timestamp           | Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.                         | No       | STRING |
| Page Name           | Name of the page that was viewed.                                                                                                                | No       | STRING |
| Page Category       | Category of the page that was viewed.                                                                                                            | No       | STRING |
| Application         | Dictionary of information about the current application.                                                                                         | No       | OBJECT |
| Campaign Parameters | Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.            | No       | OBJECT |
| Device              | Dictionary of information about the device the API call originated from.                                                                         | No       | OBJECT |
| IP Address          | The current user’s IP address.                                                                                                                   | No       | STRING |
| Locale              | Locale string for the current user, for example en-US.                                                                                           | No       | STRING |
| Location            | Dictionary of information about the user’s current location.                                                                                     | No       | OBJECT |
| Network             | Dictionary of information about the current network connection.                                                                                  | No       | OBJECT |
| Operating System    | Dictionary of information about the operating system.                                                                                            | No       | OBJECT |
| Page                | Dictionary of information about the current page in the browser.                                                                                 | No       | OBJECT |
| Screen              | Dictionary of information about the device’s screen.                                                                                             | No       | OBJECT |
| User Agent          | User agent of the device the API call originated from.                                                                                           | No       | STRING |
| Timezone            | The user’s timezone as a tz database string, for example America/New\_York.                                                                      | No       | STRING |
| Group ID            | The group or account ID a user is associated with.                                                                                               | No       | STRING |
| Properties          | Free-form dictionary of properties that describe the screen.                                                                                     | No       | OBJECT |

### Send Track

Send a track call to Segment’s tracking API. This is used to record actions your users perform.

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

| Field               | Description                                                                                                                                      | Required | Type   |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------ |
| User ID             | Unique identifier for the user in your database. A userId or an anonymousId is required.                                                         | No       | STRING |
| Anonymous ID        | A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier. A userId or an anonymousId is required. | No       | STRING |
| Timestamp           | Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.                         | No       | STRING |
| Event Name          | Name of the action that a user has performed.                                                                                                    | Yes      | STRING |
| Application         | Dictionary of information about the current application.                                                                                         | No       | OBJECT |
| Campaign Parameters | Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.            | No       | OBJECT |
| Device              | Dictionary of information about the device the API call originated from.                                                                         | No       | OBJECT |
| IP Address          | The current user’s IP address.                                                                                                                   | No       | STRING |
| Locale              | Locale string for the current user, for example en-US.                                                                                           | No       | STRING |
| Location            | Dictionary of information about the user’s current location.                                                                                     | No       | OBJECT |
| Network             | Dictionary of information about the current network connection.                                                                                  | No       | OBJECT |
| Operating System    | Dictionary of information about the operating system.                                                                                            | No       | OBJECT |
| Page                | Dictionary of information about the current page in the browser.                                                                                 | No       | OBJECT |
| Screen              | Dictionary of information about the device’s screen.                                                                                             | No       | OBJECT |
| User Agent          | User agent of the device the API call originated from.                                                                                           | No       | STRING |
| Timezone            | The user’s timezone as a tz database string, for example America/New\_York.                                                                      | No       | STRING |
| Group ID            | The group or account ID a user is associated with.                                                                                               | No       | STRING |
| Properties          | Free-form dictionary of properties that describe the screen.                                                                                     | No       | OBJECT |
| Traits              | Free-form dictionary of traits that describe the user or group of users.                                                                         | No       | OBJECT |

### Send Identify

Send an identify call to Segment’s tracking API. This is used to tie your users to their actions and record traits about them.

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

| Field               | Description                                                                                                                                      | Required | Type   |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------ |
| User ID             | Unique identifier for the user in your database. A userId or an anonymousId is required.                                                         | No       | STRING |
| Anonymous ID        | A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier. A userId or an anonymousId is required. | No       | STRING |
| Timestamp           | Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.                         | No       | STRING |
| Application         | Dictionary of information about the current application.                                                                                         | No       | OBJECT |
| Campaign Parameters | Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.            | No       | OBJECT |
| Device              | Dictionary of information about the device the API call originated from.                                                                         | No       | OBJECT |
| IP Address          | The current user’s IP address.                                                                                                                   | No       | STRING |
| Locale              | Locale string for the current user, for example en-US.                                                                                           | No       | STRING |
| Location            | Dictionary of information about the user’s current location.                                                                                     | No       | OBJECT |
| Network             | Dictionary of information about the current network connection.                                                                                  | No       | OBJECT |
| Operating System    | Dictionary of information about the operating system.                                                                                            | No       | OBJECT |
| Page                | Dictionary of information about the current page in the browser.                                                                                 | No       | OBJECT |
| Screen              | Dictionary of information about the device’s screen.                                                                                             | No       | OBJECT |
| User Agent          | User agent of the device the API call originated from.                                                                                           | No       | STRING |
| Timezone            | The user’s timezone as a tz database string, for example America/New\_York.                                                                      | No       | STRING |
| Group ID            | The group or account ID a user is associated with.                                                                                               | No       | STRING |
| Traits              | Free-form dictionary of traits that describe the user or group of users.                                                                         | No       | OBJECT |
| Address             | Dictionary of information about the user’s current Address.                                                                                      | No       | OBJECT |

### Send Group

Send a group call to Segment’s tracking API. This is used to associate an individual user with a group

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

| Field               | Description                                                                                                                                      | Required | Type   |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------ |
| User ID             | Unique identifier for the user in your database. A userId or an anonymousId is required.                                                         | No       | STRING |
| Anonymous ID        | A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier. A userId or an anonymousId is required. | No       | STRING |
| Group ID            | The group or account ID a user is associated with.                                                                                               | Yes      | STRING |
| Timestamp           | Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.                         | No       | STRING |
| Application         | Dictionary of information about the current application.                                                                                         | No       | OBJECT |
| Campaign Parameters | Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.            | No       | OBJECT |
| Device              | Dictionary of information about the device the API call originated from.                                                                         | No       | OBJECT |
| IP Address          | The current user’s IP address.                                                                                                                   | No       | STRING |
| Locale              | Locale string for the current user, for example en-US.                                                                                           | No       | STRING |
| Location            | Dictionary of information about the user’s current location.                                                                                     | No       | OBJECT |
| Network             | Dictionary of information about the current network connection.                                                                                  | No       | OBJECT |
| Operating System    | Dictionary of information about the operating system.                                                                                            | No       | OBJECT |
| Page                | Dictionary of information about the current page in the browser.                                                                                 | No       | OBJECT |
| Screen              | Dictionary of information about the device’s screen.                                                                                             | No       | OBJECT |
| User Agent          | User agent of the device the API call originated from.                                                                                           | No       | STRING |
| Timezone            | The user’s timezone as a tz database string, for example America/New\_York.                                                                      | No       | STRING |
| Traits              | Free-form dictionary of traits that describe the user or group of users.                                                                         | No       | OBJECT |

### Send Screen

Send a screen call to Segment’s tracking API. This is used to track mobile app screen views.

Send Screen is a **Cloud** action. The default Trigger is `type = "screen"`

| Field               | Description                                                                                                                                      | Required | Type   |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------ |
| User ID             | Unique identifier for the user in your database. A userId or an anonymousId is required.                                                         | No       | STRING |
| Anonymous ID        | A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier. A userId or an anonymousId is required. | No       | STRING |
| Timestamp           | Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.                         | No       | STRING |
| Screen Name         | Name of the screen that was viewed.                                                                                                              | No       | STRING |
| Application         | Dictionary of information about the current application.                                                                                         | No       | OBJECT |
| Campaign Parameters | Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.            | No       | OBJECT |
| Device              | Dictionary of information about the device the API call originated from.                                                                         | No       | OBJECT |
| IP Address          | The current user’s IP address.                                                                                                                   | No       | STRING |
| Locale              | Locale string for the current user, for example en-US.                                                                                           | No       | STRING |
| Location            | Dictionary of information about the user’s current location.                                                                                     | No       | OBJECT |
| Network             | Dictionary of information about the current network connection.                                                                                  | No       | OBJECT |
| Operating System    | Dictionary of information about the operating system.                                                                                            | No       | OBJECT |
| Page                | Dictionary of information about the current page in the browser.                                                                                 | No       | OBJECT |
| Screen              | Dictionary of information about the device’s screen.                                                                                             | No       | OBJECT |
| User Agent          | User agent of the device the API call originated from.                                                                                           | No       | STRING |
| Timezone            | The user’s timezone as a tz database string, for example America/New\_York.                                                                      | No       | STRING |
| Group ID            | The group or account ID a user is associated with.                                                                                               | No       | STRING |
| Properties          | Free-form dictionary of properties that describe the screen.                                                                                     | No       | OBJECT |

## FAQs and troubleshooting

### API Calls and MTUs

The Segment Connections destination sends data to Segment's Tracking API, which has cost implications. New users will count as new MTUs and each call will count as an API call. For information on how Segment calculates MTUs and API calls, please see [MTUs, Throughput and Billing](/docs/segment/guides/usage-and-billing/mtus-and-throughput/).

### Test Mapping

The **Test Mapping** feature on the Mapping page does not send events to the Tracking API. It only validates the mappings and confirms that the event will be accepted by the Tracking API. To send and validate the event in your source, run a RETL sync.
