Skip to main content

Hightouch Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a Hightouch location.
hightouch_api.png

Hightouch

Follow the instructions below to create a new data flow that ingests data from a Hightouch source in Nexla.

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Hightouch connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Hightouch account, and click Next; or, create a new Hightouch credential for use in this flow.

  3. In Nexla, Hightouch data sources can be created using pre-built endpoint templates, which expedite source setup for common Hightouch endpoints. Each template is designed specifically for the corresponding Hightouch endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Hightouch sources can also be configured manually, allowing you to ingest data from Hightouch endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Hightouch endpoints. Each template is designed specifically for the corresponding Hightouch endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Fetch Sources

    List all the sources in the current workspace

    • This endpoint automatically retrieves all sources in your Hightouch workspace. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://api.hightouch.com/api/v1/sources. The endpoint URL is automatically constructed based on the Hightouch API base URL.
    • The endpoint uses incrementing offset pagination (iteration.type: paging.incrementing.offset) starting from offset 0. The response data path is $.data[*], which extracts all items from the data array in the API response.
    • The endpoint expects 100 rows per page by default and automatically fetches additional pages by incrementing the offset until all sources have been retrieved.

    This endpoint retrieves all sources in your Hightouch workspace. Sources represent data sources that are connected to your Hightouch account, such as databases, data warehouses, or other data systems. The endpoint supports pagination through incrementing offset, which allows you to retrieve large lists of sources efficiently. The response includes pagination metadata that indicates the current offset and total records available. For detailed information about the API response format and available fields, see the Hightouch API documentation.

    List Models

    List all the models in the current workspace including parent and related models

    • This endpoint automatically retrieves all models in your Hightouch workspace, including parent and related models. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://api.hightouch.com/api/v1/models. The endpoint URL is automatically constructed based on the Hightouch API base URL.
    • The endpoint uses incrementing offset pagination (iteration.type: paging.incrementing.offset) starting from offset 0. The response data path is $.data[*], which extracts all items from the data array in the API response.
    • The endpoint expects 100 rows per page by default and automatically fetches additional pages by incrementing the offset until all models have been retrieved.

    This endpoint retrieves all models in your Hightouch workspace, including parent and related models. Models represent data models that define how data is structured and transformed in your Hightouch account. The endpoint supports pagination through incrementing offset, which allows you to retrieve large lists of models efficiently. The response includes pagination metadata that indicates the current offset and total records available. For detailed information about the API response format and available fields, see the Hightouch API documentation.

Configure Manually​

Hightouch data sources can be manually configured to ingest data from any valid Hightouch API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Hightouch sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Hightouch API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Hightouch API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Hightouch API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Hightouch API endpoints typically follow the pattern https://api.hightouch.com/api/v1/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Bearer Token authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. For detailed information about Hightouch API endpoints and available APIs, see the Hightouch API documentation.