Segment Connections Destination
The Segment Connections destination lets you mold data extracted from your warehouse into Segment Spec API calls that can be processed by Segment's Tracking API.
This destination is only available for Reverse ETL warehouse sources
You can only connect the Segment Connections destination to Reverse ETL warehouse sources.
- From the Segment web app, navigate to Sources and select Add Source.
- Search for HTTP API in the Sources Catalog, select the HTTP API source, and click Add Source.
- Follow the steps to name your source. This is the source that will receive API calls from the Segment Connections destination.
- Copy the Write Key on the Overview tab. You will need this when you set up the Segment Connections destination.
- From the Segment web app, navigate to Reverse ETL > Destinations.
- Click Add Destination.
- 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.
- 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.
- 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.
- Enable the configured mapping(s).
- On the Settings tab, click the Enable Destination toggle, and then click Save Changes to enable the Segment Connections destination.
The Write Key of a Segment source.
Build your own Mappings. Combine supported triggers with the following Segment Connections-supported actions:
Mapping limits per destination
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"
Optional
Unique identifier for the user in your database. A userId or an anonymousId is required.
Optional
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.
Optional
Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.
Optional
Name of the page that was viewed.
Optional
Category of the page that was viewed.
Optional
Dictionary of information about the current application.
Optional
Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.
Optional
Dictionary of information about the device the API call originated from.
Optional
The current user’s IP address.
Optional
Locale string for the current user, for example en-US.
Optional
Dictionary of information about the user’s current location.
Optional
Dictionary of information about the current network connection.
Optional
Dictionary of information about the operating system.
Optional
Dictionary of information about the current page in the browser.
Optional
Dictionary of information about the device’s screen.
Optional
User agent of the device the API call originated from.
Optional
The user’s timezone as a tz database string, for example America/New_York.
Optional
The group or account ID a user is associated with.
Optional
Free-form dictionary of properties that describe the screen.
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"
Optional
Unique identifier for the user in your database. A userId or an anonymousId is required.
Optional
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.
Optional
Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.
Name of the action that a user has performed.
Optional
Dictionary of information about the current application.
Optional
Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.
Optional
Dictionary of information about the device the API call originated from.
Optional
The current user’s IP address.
Optional
Locale string for the current user, for example en-US.
Optional
Dictionary of information about the user’s current location.
Optional
Dictionary of information about the current network connection.
Optional
Dictionary of information about the operating system.
Optional
Dictionary of information about the current page in the browser.
Optional
Dictionary of information about the device’s screen.
Optional
User agent of the device the API call originated from.
Optional
The user’s timezone as a tz database string, for example America/New_York.
Optional
The group or account ID a user is associated with.
Optional
Free-form dictionary of properties that describe the screen.
Optional
Free-form dictionary of traits that describe the user or group of users.
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"
Optional
Unique identifier for the user in your database. A userId or an anonymousId is required.
Optional
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.
Optional
Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.
Optional
Dictionary of information about the current application.
Optional
Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.
Optional
Dictionary of information about the device the API call originated from.
Optional
The current user’s IP address.
Optional
Locale string for the current user, for example en-US.
Optional
Dictionary of information about the user’s current location.
Optional
Dictionary of information about the current network connection.
Optional
Dictionary of information about the operating system.
Optional
Dictionary of information about the current page in the browser.
Optional
Dictionary of information about the device’s screen.
Optional
User agent of the device the API call originated from.
Optional
The user’s timezone as a tz database string, for example America/New_York.
Optional
The group or account ID a user is associated with.
Optional
Free-form dictionary of traits that describe the user or group of users.
Optional
Dictionary of information about the user’s current Address.
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"
Optional
Unique identifier for the user in your database. A userId or an anonymousId is required.
Optional
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.
The group or account ID a user is associated with.
Optional
Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.
Optional
Dictionary of information about the current application.
Optional
Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.
Optional
Dictionary of information about the device the API call originated from.
Optional
The current user’s IP address.
Optional
Locale string for the current user, for example en-US.
Optional
Dictionary of information about the user’s current location.
Optional
Dictionary of information about the current network connection.
Optional
Dictionary of information about the operating system.
Optional
Dictionary of information about the current page in the browser.
Optional
Dictionary of information about the device’s screen.
Optional
User agent of the device the API call originated from.
Optional
The user’s timezone as a tz database string, for example America/New_York.
Optional
Free-form dictionary of traits that describe the user or group of users.
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"
Optional
Unique identifier for the user in your database. A userId or an anonymousId is required.
Optional
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.
Optional
Timestamp when the message itself took place as a ISO-8601 format date string. Defaults to current time if not provided.
Optional
Name of the screen that was viewed.
Optional
Dictionary of information about the current application.
Optional
Dictionary of information about the campaign that resulted in the API call. This maps directly to the common UTM campaign parameters.
Optional
Dictionary of information about the device the API call originated from.
Optional
The current user’s IP address.
Optional
Locale string for the current user, for example en-US.
Optional
Dictionary of information about the user’s current location.
Optional
Dictionary of information about the current network connection.
Optional
Dictionary of information about the operating system.
Optional
Dictionary of information about the current page in the browser.
Optional
Dictionary of information about the device’s screen.
Optional
User agent of the device the API call originated from.
Optional
The user’s timezone as a tz database string, for example America/New_York.
Optional
The group or account ID a user is associated with.
Optional
Free-form dictionary of properties that describe the screen.
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.
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.