Segment
Segment (opens in a new tab) is a customer data platform (CDP) that helps businesses collect and manage customer data. Currently we support two types of integrations for Segment: the basic Segment, which allows for delete requests, and Segment Unify, which requires a Unify subscription but allows for access and delete requests.
Prerequisites
Segment
In order to integrate with Segment , you'll need to collect the following information:
Name | Description |
---|---|
Domain* | Your Segment API URL (default: platform.segmentapis.com ) |
Workspace* | Your Segment workspace ID. See Segment's guide on workspaces (opens in a new tab). |
Access token* | Your Segment access token. Follow Segment's guide for creating access tokens (opens in a new tab). |
segment_user_id* | The dataset reference to the user ID set up when calling the identify (opens in a new tab) endpoint. |
End-user Privacy
Unify
This integration requires the Business (opens in a new tab) plan for Segment, and Segment Unify (opens in a new tab) set up correctly. In order to integrate with Segment, you'll need to collect the following information:
Name | Description |
---|---|
Domain* | Your Segment API URL (default: platform.segmentapis.com ) |
Profiles domain* | Your Segment profiles API URL (default: profiles.segment.com) |
Workspace* | Your Segment workspace ID. See Segment's guide on workspaces (opens in a new tab). |
Access token* | Your Segment access token. Follow Segment's guide for creating access tokens (opens in a new tab). |
Space ID* | Your Segment space ID. See Segment's guide on spaces. (opens in a new tab). |
Access secret* | Your access secret for your profiles domain. Follow Segment's docs to retrieve this info. (opens in a new tab). |
Your Segment access token will need the following permissions: Identities
, Sources
, Spaces
, Warehouses
, and End-user Privacy
Integrating with Segment
To integrate an existing system with Segment:
- Navigate to Data map → View Systems and choose the system that you want to connect.
- Click on the Integrations tab.
- Pick the vendor or system type that you want to integrate with from the Connection type drop-down menu.
- Complete the required fields for the integration and click Save.
You may confirm your connection is working using the Test connection button, if desired.
To learn more, please see our guide for Managing Integrations.
Technical detail
Fides utilizes API endpoints to access the API service for a SaaS application. An API service is the programmatic interface through which Fides can query and update data within an application to access, rectify, or delete personal information. Each SaaS tool will have a unique set of endpoints to enable privacy functions.
Segment endpoints
In the table below, you can find which endpoints are used for each type of privacy function. Clicking on the endpoint will take you to the documentation for that endpoint.
Privacy function | Endpoint | Description |
---|---|---|
Access Requests | Segment user (opens in a new tab) | Used to retrieve profile metadata. |
Access Requests | Track events (opens in a new tab) | Used to retrieve a profile's historical events |
Access Requests | Traits (opens in a new tab) | Used to retrieve a profile's traits |
Access Requests | External IDs (opens in a new tab) | Used to retrieve a profile's external IDs |
Delete Requests | Data protection request (opens in a new tab) | Used to suppress a user or delete all their information |
By default, deletion requests are fulfilled by masking personal information. To enable Fides to delete personal information, ensure the masking_strict
variable in your fides.toml
file is set to false
.