Segment Profiles Destination
The Segment Profiles destination allows you to send your warehouse data back to Segment to create and update Profiles that can then be accessed through Profile API and activated within Twilio Engage.
This destination supports connections from Reverse ETL warehouse sources, and is not compatible with other source types.
The Segment Profiles destination is in beta and is in active development. Some functionality may change before it becomes generally available.
Getting started
Create a Profile space
To use this destination, you must have an active Segment Profile space. If you have not yet created a Segment Profile space, please follow the steps in the Profiles Onboarding Guide.
Create a Public API token
To enable the Segment Profiles destination to send data to an existing Profile space, provide an authentication token for the Segment Public API. See Segment’s Public API documentation for information on how to create a token. The token must include Source Admin permissions. You will need this token in the below steps.
Connect and configure the Segment Profiles destination
- From the Segment web app, navigate to Reverse ETL > Destinations.
- Click Add Destination.
- Select the Segment Profiles destination, click Next, and select the warehouse source that will send data to the Segment Profiles 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 Public API token created above, select an endpoint region, and click Save Changes. It is recommended to configure and enable all mappings before enabling the Segment Profiles destination.
- On the Mappings tab, click Add Mapping. Select a data model and the API call type you want to map. Identify calls will create and update user profiles and Group calls will create and update account profiles. 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 Profiles destination.
Destination Settings
| Setting | Description |
|---|---|
| Endpoint Region | Required. The region to send your data. |
| Segment Public API Token | Required. The Segment Public API requires that you have an authentication token before you send requests. This document explains how to setup a token. |
Available Actions
Build your own Mappings! Combine supported triggers with the following Segment Profiles-supported actions:
Mapping limits per destination
Individual destination instances have support a maximum of 50 mappings.
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 |
|---|---|
| Profile Space* | Type: STRINGThe Profile Space to use for creating a record. Note: This field shows list of internal sources associated with the Profile Space. Changes made to the Profile Space name in Settings will not reflect in this list unless the source associated with the Profile Space is renamed explicitly. |
| User ID | Type: STRINGUnique identifier for the user in your database. A userId or an anonymousId is required. |
| Anonymous ID | Type: STRINGA 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: STRINGThe group or account ID a user is associated with. |
| Traits | Type: OBJECTFree-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"
| Field | Description |
|---|---|
| Profile Space* | Type: STRINGThe Profile Space to use for creating a record. Note: This field shows list of internal sources associated with the Profile Space. Changes made to the Profile Space name in Settings will not reflect in this list unless the source associated with the Profile Space is renamed explicitly. |
| User ID | Type: STRINGUnique identifier for the user in your database. A userId or an anonymousId is required. |
| Anonymous ID | Type: STRINGA 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: STRINGThe group or account ID a user is associated with. |
| Traits | Type: OBJECTFree-form dictionary of traits that describe the user or group of users. |
FAQ & Troubleshooting
API Calls and MTUs
The Segment Profiles destination is not subject to API call or MTU costs. Any users or accounts created and updated by the Segment Profiles destination will not count towards your API call or MTU usage.
This page was last modified: 07 Mar 2023
Need support?
Questions? Problems? Need more info? Contact Segment Support for assistance!