> ## Documentation Index
> Fetch the complete documentation index at: https://docs.noclick.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Hex

> Connect Hex to your workflows: 29 operations across 10 categories.

The Hex node adds Hex operations to your workflows. Add it on the canvas or ask the AI builder for it by name, then pick an operation and fill in its fields.

Hex also includes 1 trigger operation (marked in the tables below) that can start a workflow when something happens in Hex.

<Note>
  You can wire the Hex node into an AI agent as a tool provider: the agent calls the operations you allow. See [Agent tools](/agents/tools).
</Note>

## Credentials

Connect Hex under **Credentials** in the node settings. See [Connecting credentials](/credentials/connecting) for the general flow.

Enter the values manually when creating the credential.

[Get your credentials here](https://app.hex.tech/settings/api-keys).

## Operations

### Admin

| Operation            | ID                | Description                                        | Trigger |
| -------------------- | ----------------- | -------------------------------------------------- | ------- |
| **Deactivate User**  | `deactivate_user` | Deactivate a workspace user.                       |         |
| **Get Current User** | `get_me`          | Return the token owner's user info.                |         |
| **List Users**       | `list_users`      | List workspace users (Admin API; Team/Enterprise). |         |

### Collections

| Operation             | ID                  | Description                                            | Trigger |
| --------------------- | ------------------- | ------------------------------------------------------ | ------- |
| **Create Collection** | `create_collection` | Create a collection.                                   |         |
| **Edit Collection**   | `edit_collection`   | Edit a collection; upsert user/group/workspace access. |         |
| **Get Collection**    | `get_collection`    | Fetch a collection's details.                          |         |
| **List Collections**  | `list_collections`  | List all collections.                                  |         |

### Data connections

| Operation                 | ID                      | Description                              | Trigger |
| ------------------------- | ----------------------- | ---------------------------------------- | ------- |
| **Edit Data Connection**  | `edit_data_connection`  | Edit a data connection / rotate secrets. |         |
| **List Data Connections** | `list_data_connections` | List configured data connections.        |         |

### Embedding

| Operation            | ID                 | Description                              | Trigger |
| -------------------- | ------------------ | ---------------------------------------- | ------- |
| **Create Embed URL** | `create_embed_url` | Create a signed embed URL for a project. |         |

### Groups

| Operation        | ID             | Description                           | Trigger |
| ---------------- | -------------- | ------------------------------------- | ------- |
| **Create Group** | `create_group` | Create a new group.                   |         |
| **Delete Group** | `delete_group` | Delete a group.                       |         |
| **Edit Group**   | `edit_group`   | Rename a group or add/remove members. |         |
| **Get Group**    | `get_group`    | Fetch a group's details.              |         |
| **List Groups**  | `list_groups`  | List all groups.                      |         |

### Projects

| Operation          | ID               | Description                                | Trigger |
| ------------------ | ---------------- | ------------------------------------------ | ------- |
| **Get Project**    | `get_project`    | Fetch metadata for a single project.       |         |
| **List Projects**  | `list_projects`  | List all projects the caller can view.     |         |
| **Update Project** | `update_project` | Update a project's status or endorsements. |         |

### Runs

| Operation              | ID                   | Description                                                | Trigger |
| ---------------------- | -------------------- | ---------------------------------------------------------- | ------- |
| **Cancel Run**         | `cancel_run`         | Cancel an in-progress run.                                 |         |
| **Get Project Runs**   | `get_project_runs`   | List recent runs for a project.                            |         |
| **Get Run Cell Image** | `get_run_cell_image` | Download a rendered PNG of a chart/cell output from a run. |         |
| **Get Run Status**     | `get_run_status`     | Get the status of a single project run.                    |         |
| **Run Project**        | `run_project`        | Trigger a run of a project's latest published version.     |         |

### Semantic models

| Operation                   | ID                        | Description                                           | Trigger |
| --------------------------- | ------------------------- | ----------------------------------------------------- | ------- |
| **Ingest Semantic Project** | `ingest_semantic_project` | Ingest a semantic project from a zip (max 3 req/min). |         |

### Sharing

| Operation                           | ID                          | Description                                              | Trigger |
| ----------------------------------- | --------------------------- | -------------------------------------------------------- | ------- |
| **Update Collection Sharing**       | `update_collection_sharing` | Add or remove a project from collections.                |         |
| **Update Group Sharing**            | `update_group_sharing`      | Add groups or change their access level on a project.    |         |
| **Update User Sharing**             | `update_user_sharing`       | Add users or change their access level on a project.     |         |
| **Update Workspace/Public Sharing** | `update_workspace_sharing`  | Set workspace-wide or public access level for a project. |         |

### Triggers

| Operation                    | ID                 | Description                                                                        | Trigger |
| ---------------------------- | ------------------ | ---------------------------------------------------------------------------------- | ------- |
| **On Project Run Completed** | `on_run_completed` | Trigger: poll a project's runs for newly-finished runs (COMPLETED/ERRORED/KILLED). | Yes     |