Tools

Create Embedding URL

Generate a presigned URL for embedding a Hex app in an external application. Supports custom user attributes, input parameter defaults, display options (theme, padding, headers), export scopes, and configurable URL expiration.

Manage Collection

Create a new collection or update an existing collection's name and description. Collections serve as organizational containers for Hex projects.

Manage Group

Create a new group or update an existing group's name and membership. When creating, provide a name and optionally initial member user IDs. When updating, provide the group ID and any combination of new name, users to add, and users to remove.

Cancel Run

Cancel an active project run. Only runs with PENDING or RUNNING status can be cancelled.

Run Project

Trigger a run of the latest published version of a Hex project. Supports custom input parameters, saved views, cache control, and notifications for run completion (via Slack, users, or groups).

Deactivate User

Deactivate a user from the Hex workspace. The user will lose access to the workspace. If your workspace uses Directory Sync, users should be managed there instead.

List Projects

List Hex projects in the workspace. Supports filtering by status, category, creator, owner, or collection. Returns paginated results sorted by most recently created first.

Get Data Connection

Retrieve detailed configuration for a specific data connection, including connection type, description, and metadata.

Get Run Status

Get the current status and details of a specific project run. Returns the run status (PENDING, RUNNING, ERRORED, COMPLETED, KILLED), timestamps, and elapsed time.

List Collections

List all collections in the Hex workspace. Collections are organizational containers for projects. Returns paginated results with collection names, descriptions, and timestamps.

Update Project Status

Add or remove a status (including endorsements) from a Hex project. Set status to null to remove the current status.

List Users

List workspace users with their name, email, role, and last login date. Results are paginated and can be sorted.

List Groups

List all groups in the Hex workspace. Returns group names, IDs, and creation dates with pagination support.

List Data Connections

List all data connections configured in the Hex workspace. Returns connection names, types, and metadata with pagination support.

Delete Group

Delete a group from the Hex workspace. This removes the group and its associated permissions.

Get Project

Retrieve detailed metadata about a single Hex project, including title, description, status, categories, creator, owner, timestamps, and optionally sharing permissions.

List Project Runs

List API-triggered runs of a Hex project. Can filter by run status (PENDING, RUNNING, ERRORED, COMPLETED, KILLED). Returns run details including status, timestamps, and notifications.

Get Queried Tables

Retrieve the list of warehouse tables queried by a Hex project. Useful for observability and understanding data dependencies. Returns connection and table information.

Manage Project Sharing

Configure sharing permissions for a Hex project. Supports setting access at multiple levels: individual users, groups, collections, workspace-wide, and public web. Access levels include NONE, APP_ONLY, CAN_VIEW, CAN_EDIT, and FULL_ACCESS. You can update one or more sharing levels in a single call.

Create Project

Create a new Hex project in the workspace with a title and optional description.