Segment Profiles Destination
Destination Info
- Accepts Group, and Identify calls
- Refer to it as Segment Profiles in the Integrations object
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.
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.
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, 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.
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 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. |
| Timestamp | Type: DATETIMEThe timestamp of the event. |
| MessageId | Type: STRINGThe Segment messageId. |
| Consent | Type: OBJECTSegment event consent category preferences. |
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. |
| Timestamp | Type: DATETIMEThe timestamp of the event. |
| MessageId | Type: STRINGThe Segment messageId. |
| Consent | Type: OBJECTSegment event consent category preferences. |
Send Subscriptions
Send an identify call to Segment’s tracking API. This is used to get user channel subscription data into Engage.
Send Subscriptions 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. |
| Anonymous ID | Type: STRINGA pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier. |
Type: STRINGEmail of the user |
|
| Email Subscription Status | Type: STRINGGlobal status of the email subscription. True is subscribed, false is unsubscribed, and did_not_subscribe is did_not_subscribe. |
| Email Subscription Groups | Type: OBJECTGroup Subscription statuses are supported for the email channel. This object contains group names as keys and statuses as values. True is subscribed, false is unsubscribed, and did_not_subscribe is did_not_subscribe. |
| Phone | Type: STRINGPhone number of the user |
| SMS Subscription Status | Type: STRINGGlobal status of the SMS subscription. True is subscribed, false is unsubscribed, and did_not_subscribe is did_not_subscribe. |
| WhatsApp Subscription Status | Type: STRINGGlobal status of the WhatsApp subscription. True is subscribed, false is unsubscribed, and did_not_subscribe is did_not_subscribe. |
| Android Push Token | Type: STRINGAndroid Push Token of the user |
| Android Push Subscription Status | Type: STRINGGlobal status of the android push subscription. True is subscribed, false is unsubscribed, and did_not_subscribe is did_not_subscribe. |
| Ios Push Token | Type: STRINGIos Push Token of the user |
| Ios Push Subscription Status | Type: STRINGGlobal status of the ios push subscription. True is subscribed, false is unsubscribed, and did_not_subscribe is did_not_subscribe. |
| Traits | Type: OBJECTFree-form dictionary of traits that describe the user or group of users. |
| Timestamp | Type: DATETIMEThe timestamp of the event. |
| MessageId | Type: STRINGThe Segment messageId. |
| Consent | Type: OBJECTSegment event consent category preferences. |
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.
| 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. |
| Timestamp | Type: DATETIMEThe timestamp of the event. |
| Event Name* | Type: STRINGName of the action that a user has performed. |
| Group ID | Type: STRINGThe group or account ID a user is associated with. |
| Properties | Type: OBJECTFree-form dictionary of properties that describe the event. |
| MessageId | Type: STRINGThe Segment messageId. |
| Consent | Type: OBJECTSegment event consent category preferences. |
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.
Succesful syncs but no changes on profiles
Make sure that the Endpoint Region setting matches the region of your workspace. If the region is correct and you don’t see any profile changes, contact Segment.
Test Mapping
The Test Mapping feature on the Mapping page does not send events to Profiles. It will only validate the mappings and confirm that the event will be accepted by the Tracking API. To send and validate the event in profile, please run a RETL sync.
This page was last modified: 08 Feb 2024
Need support?
Questions? Problems? Need more info? Contact Segment Support for assistance!