Connecting to Hevo

Michał Trybulec - Dataedo Team Michał Trybulec 13th March, 2025

Connection requirements

Dataedo connects to Hevo using a REST API. To set up this connection, you'll need an API Key and an API Secret. These credentials are generated within the Hevo platform and are used to authenticate requests to the API. You can find the instructions for generating an API Key and Secret here.

Required permissions

Dataedo utilizes the following REST API endpoints to extract metadata from Hevo:

  • /pipelines
  • /pipelines/{pipelineId}
  • /pipelines/{pipelineId}/objects
  • /pipelines/{pipelineId}/transformations
  • /pipelines/{pipelineId}/event-types
  • /pipelines/{pipelineId}/mappings/{eventName}
  • /models
  • /models/{modelId}

Connecting to Hevo

ℹ️ Important
For best results before importing metadata from Hevo, ensure that the destination and sources used in Hevo are already imported into Dataedo.

Connector selection

To import Hevo, click the Add button in the upper left corner and choose New connection.

Image title

From the sources, choose Hevo, and then click Next >

Image title

Connection details

Fill in the Hevo Address Base with Hevo API Base URL,

API Key and API Secret fields with the credentials generated in Hevo.

Select the pipeline.

Confirm the connection by clicking Connect.

Image title

Filtering and documentation title

You can filter by name. After setting up filters, click Next >.

Image title

You can set up the documentation title. By default, it is the name of the destination. You can change it to a more descriptive one. After setting up the title, click Import.

Successful first import

The first import should be relatively quick. After it is done, click Finish.

Image title

Assigning linked sources

After the first import, if the linked sources do not automatically link, you must assign the linked sources to the corresponding source database in Dataedo. To do this, go to the Linked sources folder in Hevo documentation, select a linked source to be assigned, expand Source Database and select the corresponding Source Database from the list.

Image title

Repeat this step for all linked sources that can be assigned. When linked sources are assigned their logo will change to a database icon.

Image title

Importing changes for data lineage

After assigning linked sources, you must import changes to import data lineage. To do this right-click on the Hevo documentation and choose Import changes. Confirm the import by clicking Connect.

Image title

Known limitations

Dataedo only works with Hevo sources that are applications (like Salesforce) or databases (like SQL Server) and are also supported by Dataedo. It doesn’t support other types of sources like events (such as Apache Kafka), files (like Amazon S3), functions (such as AWS Lambda), or sources without a corresponding connector in Dataedo (like Google Analytics).

Linked sources are not assigned automatically, this must be done manually.

Dataedo only imports information from the source connectors that are currently connected.