Segment Destination

On this page


Destination Info

The Segment destination enables you to mold data extracted from your warehouse into Segment Spec API calls that can be processed by Segment’s Tracking API.

The Segment destination can be connected to Reverse ETL warehouse sources only.

The Segment (Actions) destination is in beta and is in active development. Some functionality may change before it becomes generally available.

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, and click Add Source.
  3. Follow the steps to name your source. This is the source that will receive API calls from the Segment destination.
  4. Copy the Write Key on the Overview tab. You will need this when you set up the Segment destination.

Connect and configure the Segment destination

  1. From the Segment web app, navigate to Reverse ETL > Destinations.
  2. Click Add Destination in top-right corner.
  3. Select the Segment destination, click Next, and select the warehouse source that will send data to the Segment destination. If you have not set up a warehouse source, follow the steps in the Reverse ETL documentation on 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 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 destination.

Destination Settings

Setting Description
Endpoint Region Required.

The region to send your data.

Source Write Key Required.

The Write Key of a Segment source.

Available Actions

Build your own Mappings! Combine supported triggers with the following Segment-supported actions:

Mapping limits per destination

Individual destination instances have support a maximum of 50 mappings.

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"

Click to show / hide fields

Field Description
User ID Type: STRING

Unique identifier for the user in your database. A userId or an anonymousId is required.

Anonymous ID Type: STRING

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.

Timestamp Type: STRING

Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.

Page Name Type: STRING

Name of the page that was viewed.

Page Category Type: STRING

Category of the page that was viewed.

Application Type: OBJECT

Dictionary of information about the current application.

Campaign Parameters Type: OBJECT

Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.

Device Type: OBJECT

Dictionary of information about the device the API call originated from.

IP Address Type: STRING

The current user’s IP address.

Locale Type: STRING

Locale string for the current user, for example en-US.

Location Type: OBJECT

Dictionary of information about the user’s current location.

Network Type: OBJECT

Dictionary of information about the current network connection.

Operating System Type: OBJECT

Dictionary of information about the operating system.

Page Type: OBJECT

Dictionary of information about the current page in the browser.

Screen Type: OBJECT

Dictionary of information about the device’s screen.

User Agent Type: STRING

User agent of the device the API call originated from.

Timezone Type: STRING

The user’s timezone as a tz database string, for example America/New_York.

Group ID Type: STRING

The group or account ID a user is associated with.

Properties Type: OBJECT

Free-form dictionary of properties that describe the screen.

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"

Click to show / hide fields

Field Description
User ID Type: STRING

Unique identifier for the user in your database. A userId or an anonymousId is required.

Anonymous ID Type: STRING

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.

Timestamp Type: STRING

Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.

Event Name* Type: STRING

Name of the action that a user has performed.

Application Type: OBJECT

Dictionary of information about the current application.

Campaign Parameters Type: OBJECT

Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.

Device Type: OBJECT

Dictionary of information about the device the API call originated from.

IP Address Type: STRING

The current user’s IP address.

Locale Type: STRING

Locale string for the current user, for example en-US.

Location Type: OBJECT

Dictionary of information about the user’s current location.

Network Type: OBJECT

Dictionary of information about the current network connection.

Operating System Type: OBJECT

Dictionary of information about the operating system.

Page Type: OBJECT

Dictionary of information about the current page in the browser.

Screen Type: OBJECT

Dictionary of information about the device’s screen.

User Agent Type: STRING

User agent of the device the API call originated from.

Timezone Type: STRING

The user’s timezone as a tz database string, for example America/New_York.

Group ID Type: STRING

The group or account ID a user is associated with.

Properties Type: OBJECT

Free-form dictionary of properties that describe the screen.

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"

Click to show / hide fields

Field Description
User ID Type: STRING

Unique identifier for the user in your database. A userId or an anonymousId is required.

Anonymous ID Type: STRING

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.

Timestamp Type: STRING

Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.

Application Type: OBJECT

Dictionary of information about the current application.

Campaign Parameters Type: OBJECT

Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.

Device Type: OBJECT

Dictionary of information about the device the API call originated from.

IP Address Type: STRING

The current user’s IP address.

Locale Type: STRING

Locale string for the current user, for example en-US.

Location Type: OBJECT

Dictionary of information about the user’s current location.

Network Type: OBJECT

Dictionary of information about the current network connection.

Operating System Type: OBJECT

Dictionary of information about the operating system.

Page Type: OBJECT

Dictionary of information about the current page in the browser.

Screen Type: OBJECT

Dictionary of information about the device’s screen.

User Agent Type: STRING

User agent of the device the API call originated from.

Timezone Type: STRING

The user’s timezone as a tz database string, for example America/New_York.

Group ID Type: STRING

The group or account ID a user is associated with.

Traits Type: OBJECT

Free-form dictionary of traits that describe the user or group of users.

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"

Click to show / hide fields

Field Description
User ID Type: STRING

Unique identifier for the user in your database. A userId or an anonymousId is required.

Anonymous ID Type: STRING

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.

Group ID* Type: STRING

The group or account ID a user is associated with.

Timestamp Type: STRING

Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.

Application Type: OBJECT

Dictionary of information about the current application.

Campaign Parameters Type: OBJECT

Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.

Device Type: OBJECT

Dictionary of information about the device the API call originated from.

IP Address Type: STRING

The current user’s IP address.

Locale Type: STRING

Locale string for the current user, for example en-US.

Location Type: OBJECT

Dictionary of information about the user’s current location.

Network Type: OBJECT

Dictionary of information about the current network connection.

Operating System Type: OBJECT

Dictionary of information about the operating system.

Page Type: OBJECT

Dictionary of information about the current page in the browser.

Screen Type: OBJECT

Dictionary of information about the device’s screen.

User Agent Type: STRING

User agent of the device the API call originated from.

Timezone Type: STRING

The user’s timezone as a tz database string, for example America/New_York.

Traits Type: OBJECT

Free-form dictionary of traits that describe the user or group of users.

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"

Click to show / hide fields

Field Description
User ID Type: STRING

Unique identifier for the user in your database. A userId or an anonymousId is required.

Anonymous ID Type: STRING

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.

Timestamp Type: STRING

Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.

Screen Name Type: STRING

Name of the screen that was viewed.

Application Type: OBJECT

Dictionary of information about the current application.

Campaign Parameters Type: OBJECT

Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.

Device Type: OBJECT

Dictionary of information about the device the API call originated from.

IP Address Type: STRING

The current user’s IP address.

Locale Type: STRING

Locale string for the current user, for example en-US.

Location Type: OBJECT

Dictionary of information about the user’s current location.

Network Type: OBJECT

Dictionary of information about the current network connection.

Operating System Type: OBJECT

Dictionary of information about the operating system.

Page Type: OBJECT

Dictionary of information about the current page in the browser.

Screen Type: OBJECT

Dictionary of information about the device’s screen.

User Agent Type: STRING

User agent of the device the API call originated from.

Timezone Type: STRING

The user’s timezone as a tz database string, for example America/New_York.

Group ID Type: STRING

The group or account ID a user is associated with.

Properties Type: OBJECT

Free-form dictionary of properties that describe the screen.

FAQ & Troubleshooting

API Calls and MTUs

The Segment 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.

This page was last modified: 13 Dec 2022



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account