Hex

These are the Hex actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Create Cell

  Tool to create a new cell in the draft version of a Hex project. Use when adding CODE or SQL cells to a project. Only CODE and SQL cell types are supported. Requires EDIT_PROJECT_CONTENTS permission.

• Create Collection

  Tool to create a new collection in the Hex workspace. Use when you need to organize projects and resources into a collection.

• Deactivate User

  Deactivates a user in the Hex workspace. Use this when you need to deactivate a user by their ID.

• Delete Cell

  Permanently delete a cell from the draft version of a project. Requires EDIT_PROJECT_CONTENTS permission. Use when you need to remove a cell from a Hex project's draft.

• Delete Group

  Deletes a group from the Hex workspace. Use this when you need to permanently remove a group by its ID.

• Delete Guide Draft

  Deletes a guide draft by ID from Hex. Use this when you need to permanently remove a draft guide.

• Edit Group

  Tool to edit a group's name and/or members in Hex. Use when you need to update group details, add users to a group, or remove users from a group.

• Get Project

  Tool to get metadata about a single Hex project. Use when you need to retrieve project details including title, description, creator, owner, status, categories, analytics, schedules, and sharing information.

• Get Project Runs

  Tool to retrieve the status of API-triggered runs for a specific Hex project. Use when you need to check the execution status, timing, or history of project runs. Returns a paginated list of runs with detailed status information.

• Get Run Status

  Tool to retrieve the status of a specific Hex project run. Use when you need to check the current state, timing, or completion status of a project execution. Returns detailed information including start/end times, elapsed time, status, and notification details.

• List Cells

  Tool to list all cells from the draft version of a Hex project. Use when you need to retrieve cells with source code for SQL and CODE cells. Returns paginated results with cell details including type, label, and contents.

• List Collections

  Tool to retrieve all collections in the workspace with pagination support. Use when you need to list or discover available collections.

• List groups

  Tool to list all groups in the Hex workspace with pagination support. Use when you need to retrieve groups with optional sorting and pagination.

• List Hex Projects

  Tool to list all viewable Hex projects with pagination and filtering support. Use when you need to retrieve projects sorted by creation date or filter by status, categories, creator, owner, or collection.

• List Users

  Tool to list all users in the Hex workspace with pagination support. Returns user details including names, emails, roles, and last login dates. Use when you need to retrieve users, filter by group, or paginate through large user lists.

• Run Project

  Tool to trigger a run of the latest published version of a Hex project. Use when you need to execute a project programmatically. Rate limited to 20 requests per minute and 60 requests per hour.

• Update Cell

  Tool to update a cell's source code and/or data connection in Hex. Use when you need to modify the contents of a code cell or SQL cell. Requires EDIT_PROJECT_CONTENTS permission.

• Upsert Guide Draft

  Tool to update or create guide drafts by filePath. Creates a new guide if it doesn't exist, creates a draft if the guide exists without a draft, or updates an existing draft. Use when you need to programmatically manage guide content in Hex.

• Cancel Run

  Tool to cancel a project run that is in progress. Use when you need to stop a currently executing Hex project run before it completes.

• Create Group

  Tool to create a new group in the Hex workspace. Use when you need to organize users into groups for collaboration and access control.

• Edit Collection

  Tool to edit a collection's name, description, and sharing settings in Hex. Use when you need to update collection metadata or change sharing permissions.

• Edit Project Sharing Collections

  Tool to add a project to collections or remove it from collections. Use when you need to update project sharing by adding or modifying collection access. Workspace tokens need Collections -> Write access scope in addition to Projects -> Write access scope.

• Edit Project Sharing Groups

  Tool to edit project sharing settings for groups in Hex. Use when you need to add or modify group access to a project. Supports up to 25 groups per request.

• Edit Project Sharing Settings

  Tool to edit project sharing settings for workspace members and public web access. Use when you need to control who can access a Hex project and what permissions they have.

• Edit Project Sharing Users

  Tool to edit project sharing settings for individual users in Hex. Add or modify user access to a project by specifying access levels (NONE, APP_ONLY, CAN_VIEW, CAN_EDIT, FULL_ACCESS). Use when you need to grant or update project permissions for specific users. Maximum 25 users per request.

• Get Cell

  Tool to get a single cell by ID from the draft version of a Hex project. Use when you need to retrieve cell details including source contents for CODE and SQL cells. Returns complete cell information including cell type, contents, and associated metadata.

• Get collection

  Tool to get information about a specific collection in Hex. Returns collection details including name, description, creator, and sharing settings. Use when you need to retrieve metadata about a collection by its ID.

• Get Group

  Tool to retrieve information about a specific Hex group. Use when you need to get details about a group including its ID, name, and creation date.

• List Data Connections

  Tool to list all data connections in the Hex workspace with pagination support. Use when you need to retrieve, browse, or audit data connections configured in Hex. Supports filtering by sort criteria and cursor-based pagination for large result sets.

• Publish Guide Drafts

  Tool to publish all currently drafted guides or specific guides by ID. Use when you need to make draft guides publicly available. Specify either publishAllDraftGuides=true or provide specific guide IDs.

• Update Project Status

  Tool to add or remove a status (including endorsements) from a Hex project. Use when you need to update the project's status or remove an existing status by setting it to null.