Integrating Segment with TrustWorks for Enhanced Data Mapping

Integrating Segment with TrustWorks enables organisations to automatically discover and map data sources and destinations, ensuring the maintenance of an accurate and comprehensive data map and simplifying the data mapping process.

Prerequisites

Before embarking on the integration process, you must generate an API key in Segment. The permissions assigned to this key will vary based on your intended use cases:

  • For Data Repository Discovery: A token with 'source read-only' permission is adequate.
  • For Data Subject Request Automation (Erasure): A token with a broader scope is necessary, and it must be generated by the workspace owner, as 'read-only' rights are insufficient.

Generate Segment API Key

To integrate Segment with TrustWorks, follow these steps:

  1. Log in to the Segment App, and choose the Workspace you want to generate a token for. Each Segment Workspace requires a separate token*.

  1. ClickSettings in the left menu to access your Segment Workspace Settings.
  2. Navigate to the Access Management , and click Tokens . This tab lists any existing tokens created for the Workspace.

  1. Click + Create Token , and follow the prompts to generate a new token. Be sure to select a Public API token, and not a Config API token. Once generated, store the token somewhere safe, like a password store or other secrets manager.

Note

If your intention is to utilise this integration for DSR Automation, opt for 'Workspace Member' permission. For Data Mapping purposes only, choose 'Workspace Member with source read-only' permission.



For additional information on Segment API Tokens, refer to the Segment API Documentation.


Configuring Segment Integration in TrustWorks

  1. Log in to your TrustWorks account. Navigate to Global Settings > Integrations .
  2. Click on + New Integration .
  3. Choose the Segment integration option.

  1. In the configuration panel, provide the API key and Workspace Name.
  2. Click Test Integration to verify the connection.

  1. If the test is successful and the connection is established, proceed tosave the integration.

  1. Verify the visibility of Segment sources and destinations in Data Mapping > Staging .

Troubleshooting

If you encounter a “Failed to Establish connection” error during setup, ensure the API key has the correct permissions. If using Segment for Data Subject Request automation, the token must have broader scope permissions and be generated by the workspace owner.

Conclusion

The integration of Segment with TrustWorks streamlines the data mapping process, enabling seamless management and tracking of data assets. For any questions or additional support, please contact us.

Additional Notes

  • Segment has separated access tokens between Public API and Config API. Ensure to use Public API tokens as TrustWorks now only supports Public API.
  • Update the documentation promptly whenever there are changes on either the Segment or TrustWorks side to avoid any inconvenience to the users.

Still need help? Contact Us Contact Us