Skip to main content

How to Set up Hex

Updated over a week ago

This setup should take 5 minutes.

1. Create Token in Hex

There are two options for connecting Foundational with Hex:

Option 1: Workspace Token (Recommended)

  • A read-only token that provides workspace-level access

  • More secure as it has limited permissions

  • Ideal for data ingestion purposes

Option 2: Personal Access Token (PAT)

  • Uses your personal user permissions

  • May have broader access than needed

  • Ingestion will be done with your user's permissions

In order to create the token, please follow these steps:

  1. Go to your Hex workspace settings

  2. Navigate to the API keys section

  3. Choose either "Workspace Token" (recommended) or "Personal Access Token"

    1. For Workspace Token: ensure it has read-only permissions

  4. Copy the generated token aside, we will use it in the next step

2. Configure Hex in Foundational

  1. Open the Integrations page in Foundational

  2. Fill in the following information:

    1. Hex Base URL
      The URL of your Hex workspace. This is the web address you use to access Hex, for example: https://app.hex.tech or https://yourcompany.hex.tech
      You can find this in your browser's address bar when you're logged into Hex.
      ​

    2. Workspace Name
      The name of your Hex workspace. This is typically your organization or team name within Hex.
      You can find this in your Hex workspace settings or in the URL path when navigating through your workspace: https://app.hex.tech/<workspace_name>
      ​

    3. Hex Token
      An API Bearer token that allows Foundational to access your Hex workspace. Hex supports two types of authentication tokens:
      ​
      ​

Did this answer your question?