Hex Tools

Hex is a collaborative data workspace for building notebooks, apps, and dashboards. These tools let a workflow trigger and monitor Hex project runs, inspect projects and their queried tables, and manage workspace resources such as collections, groups, users, and data connections.

Overview

Operations

All operations call the Hex REST API at https://app.hex.tech/api/v1 and authenticate with the Authorization: Bearer <apiKey> header.

Configuration

hex_run_project

hex_get_run_status

hex_get_project_runs

hex_cancel_run

hex_list_projects

hex_get_project

hex_update_project

hex_get_queried_tables

hex_list_users

hex_list_groups

hex_get_group

hex_list_collections

hex_get_collection

hex_create_collection

hex_list_data_connections

hex_get_data_connection

Outputs

hex_run_project

• projectId (string) — Project ID.
• runId (string) — Run ID.
• runUrl (string) — URL to view the run.
• runStatusUrl (string) — URL to check run status.
• traceId (string) — Trace ID.
• projectVersion (number) — Project version.

hex_get_run_status

• projectId (string) — Project ID.
• runId (string) — Run ID.
• runUrl (string) — URL to view the run.
• status (string) — Run status.
• startTime (string) — Run start time.
• endTime (string) — Run end time.
• elapsedTime (number) — Elapsed time in ms.
• traceId (string) — Trace ID.
• projectVersion (number) — Project version.

hex_get_project_runs

• runs (json) — List of project runs.
• total (number) — Total number of runs.
• traceId (string) — Trace ID.

hex_cancel_run

• success (boolean) — Whether the run was cancelled.
• projectId (string) — Project ID.
• runId (string) — Run ID that was cancelled.

hex_list_projects

• projects (json) — List of projects.
• total (number) — Total number of projects.

hex_get_project

• id (string) — Project ID.
• title (string) — Project title.
• description (string) — Project description.
• status (json) — Project status object.
• type (string) — Project type.
• creator (json) — Creator info.
• owner (json) — Owner info.
• categories (json) — Project categories.
• lastEditedAt (string) — Last edited timestamp.
• lastPublishedAt (string) — Last published timestamp.
• createdAt (string) — Creation timestamp.
• archivedAt (string) — Archive timestamp.
• trashedAt (string) — Trash timestamp.

hex_update_project

• id (string) — Project ID.
• title (string) — Project title.
• description (string) — Project description.
• status (json) — Project status.
• type (string) — Project type.
• creator (json) — Creator info.
• owner (json) — Owner info.
• categories (json) — Project categories.
• lastEditedAt (string) — Last edited timestamp.
• lastPublishedAt (string) — Last published timestamp.
• createdAt (string) — Creation timestamp.
• archivedAt (string) — Archive timestamp.
• trashedAt (string) — Trash timestamp.

hex_get_queried_tables

• tables (json) — List of queried tables.
• total (number) — Total number of tables.

hex_list_users

• users (json) — List of users.
• total (number) — Total number of users.

hex_list_groups

• groups (json) — List of groups.
• total (number) — Total number of groups.

hex_get_group

• id (string) — Group ID.
• name (string) — Group name.
• createdAt (string) — Creation timestamp.

hex_list_collections

• collections (json) — List of collections.
• total (number) — Total number of collections.

hex_get_collection

• id (string) — Collection ID.
• name (string) — Collection name.
• description (string) — Collection description.
• creator (json) — Creator info.

hex_create_collection

• id (string) — Collection ID.
• name (string) — Collection name.
• description (string) — Collection description.
• creator (json) — Creator info.

hex_list_data_connections

• connections (json) — List of data connections.
• total (number) — Total number of connections.

hex_get_data_connection

• id (string) — Data connection ID.
• name (string) — Data connection name.
• type (string) — Connection type.
• description (string) — Connection description.
• connectViaSsh (boolean) — Whether SSH tunnel is used.
• includeMagic (boolean) — Whether magic is included.
• allowWritebackCells (boolean) — Whether writeback cells are allowed.

YAML Example

hex_1:
  type: hex
  name: "Hex"
  inputs:
    operation: "hex_run_project"
    apiKey: "{{HEX_API_KEY}}"
    projectId: "5a6f8c2e-1234-4abc-9def-0123456789ab"
    inputParams: '{"date_range": "2024-01-01", "department": "engineering"}'
  connections:
    outgoing:
      - target: next-block-id

Tips

• Generate an API key from your Hex workspace settings (Settings → API keys). It is passed as a Bearer token, so treat it as a secret and store it as an environment variable referenced with {{HEX_API_KEY}} rather than hardcoding it.
• hex_run_project returns asynchronously: capture {{hex_1.runId}} and {{hex_1.runStatusUrl}}, then poll with hex_get_run_status (or feed the run into a wait/loop) to detect COMPLETED, ERRORED, or KILLED before continuing.
• inputParams for hex_run_project may be a JSON object or a JSON string; string values are parsed automatically. Use keys that match the input parameter names defined in the Hex project.
• All projectId, runId, groupId, collectionId, and dataConnectionId values are UUIDs from Hex — copy them from the project URL or the relevant list operation (hex_list_projects, hex_list_groups, etc.).