Skip to main content

Hex

Data science platform for managing projects, runs, collections, groups, users, and data connections.

Categories: Data & Analytics, Notebooks

What you can ask​

  • Run the Daily KPI Hex project and post the summary in #leadership.
  • List Hex projects shared with external@partner.com for a security review.
  • Find projects that haven't been opened in 90 days.

Set up​

Hex connects with credentials from your Hex account. Have these values ready:

  • API token
  1. Go to Organization > Connectors and find Hex.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

Hex offers 41 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (18)​

View and search information without changing it.

ToolWhat it does
get_cellGet a cell by ID within a project.
get_collectionGet a collection by ID including name, description, creator, and sharing settings.
get_current_userGet the authenticated user's profile including name, email, and workspace role.
get_data_connectionGet a data connection by ID including configuration, sharing, and schema settings.
get_groupGet a group by ID including name and creation date.
get_projectGet metadata for a single project by ID.
get_queried_tablesGet warehouse tables queried within a project.
get_run_chart_imageGet a rendered PNG chart image from a completed project run.
get_run_statusGet detailed status of a specific project run including timing, state events, and notifications.
list_cellsList cells in a project with pagination.
list_collectionsList collections in the workspace with pagination.
list_data_connectionsList accessible data connections with pagination.
list_groupsList workspace groups with pagination.
list_guide_draftsList guide drafts with pagination.
list_project_runsList run history for a project.
list_projectsList projects in the workspace.
list_usersList workspace users with pagination.
validate_credentialValidate Hex API token by retrieving the current user profile.

Write (6)​

Create or send data.

ToolWhat it does
create_cellCreate a new cell in a project.
create_collectionCreate a new collection to organize projects.
create_data_connectionCreate a new data connection.
create_groupCreate a new workspace group with optional initial members.
create_projectCreate a new project in the workspace with a title and optional description.
run_projectTrigger a run of a published project.

Delete or overwrite (17)​

Remove or replace existing data.

ToolWhat it does
cancel_runCancel an in-progress project run.
deactivate_userDeactivate a workspace user.
delete_cellDelete a cell from a project permanently.
delete_groupDelete a workspace group permanently.
delete_guide_draftDelete a guide draft permanently.
publish_guide_draftsPublish guide drafts.
share_project_collectionsAdd a project to collections with specific access levels (APP_ONLY, CAN_VIEW, CAN_EDIT, FULL_ACCESS, NONE).
share_project_groupsShare a project with groups.
share_project_usersShare a project with specific users.
update_cellUpdate a cell's content or configuration within a project.
update_collectionUpdate a collection's name or description.
update_connection_schemaUpdate a data connection's schema filters to include or exclude databases, schemas, or tables.
update_data_connectionUpdate a data connection's name, description, configuration, or sharing settings.
update_groupUpdate a group's name and membership.
update_projectUpdate a project's status or endorsements.
update_project_visibilityUpdate workspace-wide and public web sharing for a project.
upsert_guide_draftCreate or update a guide draft.
⌘J