Skip to main content

How to Set up Hex

Updated this week

Setup takes about 5 minutes.

Introduction

Connecting Hex to Foundational allows Foundational to read metadata, list assets, and identify data sources.

To make the connection, you need to:

  • Create a Workspace Token or Personal Access Token (PAT) in Hex
    ​

  • Connect to Foundational using your Hex URL, workspace name, and token

Prerequisites

Ensure you have:

  • Access to Hex workspace settings
    ​

  • Permission to create either a Workspace Token or a Personal Access Token
    ​

  • Added Foundational IP addresses to the allowlist, see the article Allowing IP access to Foundational.

Access permissions

The permissions you assign in the Hex token allow Foundational to:

  • Read project metadata
    ​

  • List data connections and identify referenced data sources

Create a token in Hex

You can connect to Foundational using either a Workspace token or a Personal Access Token (PAT). For more information, see the Hex documentation.
​

Option 1: Create a Workspace token (recommended)


A Workspace token provides read-only access and limits permissions to the workspace level.

  1. In your Hex workspace, go to Workspace settings > API Keys.
    ​

  2. Select Workspace Token.
    ​

  3. Create a new token. Ensure the token has these read-only permissions:
    ​

    • Projects: Read access
      ​

    • Data connections: Read access
      ​

  4. Copy the token and store it safely. You’ll need it to set up the connection.

Option 2: Create a Personal Access Token


A Personal Access Token (PAT) inherits your own user permissions and may assign Foundational a wider permissions set than is actually required.

  1. In your Hex workspace, go to User settings > API Keys.
    ​

  2. Select Personal Access Token.
    ​

  3. Create a new token.
    ​

  4. Copy the token and store it safely. You’ll need it to set up the connection.

Connect Foundational to Hex

  1. In Foundational, open the Connectors & Integrations page.
    ​

  2. In BI & Analytics, select the Hex card and click Connect.
    ​

  3. A screen opens. Click Add database.
    ​

  4. The initial setup screen opens. Click Start Setup.
    ​

  5. The Setup New Connection screen opens.
    ​

    Enter the details:
    ​

    • Hex Base URL: The URL of your Hex workspace
      e.g., https://app.hex.tech or https://yourcompany.hex.tech.
      ​

    • Hex Workspace Name: Your organization or team name that is part of your URL e.g., https://app.hex.tech/<workspace_name>.
      ​
      You can find this in your Hex workspace Settings or in the URL path when navigating your workspace: https://app.hex.tech/<workspace_name>.
      ​

    • Hex Token: Enter the Workspace token or Personal Access Token you created in Hex.
      ​

  6. Click Next.
    ​

  7. The final setup screen opens. To complete the connection, click Save.

That’s it. Foundational is now connected to Hex.

Related Articles
How to set up Sisense
How to set up Azure Repos
How to set up Bitbucket
How to Set up Databricks
How to set up Talend ETL
Did this answer your question?