- Category: analytics
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 32
- Triggers: 0
- Slug:
HEX - Version: 20261101_00
Tools
Cancel Run
Cancel Run
Slug:
HEX_CANCEL_RUNTool to cancel a project run that is in progress. Use when you need to stop a currently executing Hex project run before it completes.Input Parameters
Unique ID for a run of a Hex project in UUID format. This identifies the specific run to cancel.
Unique ID for a Hex project in UUID format. This identifies the project that contains the run to cancel.
Output
Create Cell
Create Cell
Create Collection
Create Collection
Create Group
Create Group
Deactivate User
Deactivate User
Delete Cell
Delete Cell
Slug:
HEX_DELETE_CELLPermanently 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.Input Parameters
Unique identifier for the cell to delete. Must be in UUID format (e.g., ‘019cd2fb-8a0d-7007-9870-c3999f91e95b’).
Output
Delete Group
Delete Group
Delete Guide Draft
Delete Guide Draft
Edit Collection
Edit Collection
Edit Group
Edit Group
Edit Project Sharing Collections
Edit Project Sharing Collections
Slug:
HEX_EDIT_PROJECT_SHARING_COLLECTIONSTool 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.Input Parameters
Output
Edit Project Sharing Groups
Edit Project Sharing Groups
Slug:
HEX_EDIT_PROJECT_SHARING_GROUPSTool 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.Input Parameters
Sharing configuration specifying which groups to add or modify and their access levels
Output
Edit Project Sharing Settings
Edit Project Sharing Settings
Slug:
HEX_EDIT_PROJECT_SHARING_ORG_AND_PUBLICEdit a Hex project’s workspace-member and public-web sharing settings. Both access levels must be supplied in each request.Input Parameters
Sharing configuration with publicWeb and workspace access levels. Both fields are required.
Unique ID for a Hex project (UUID format). This is the project whose sharing settings will be updated.
Output
Edit Project Sharing Users
Edit Project Sharing Users
Slug:
HEX_EDIT_PROJECT_SHARING_USERSTool 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.Input Parameters
Unique ID for the Hex project in UUID format (e.g., ‘019cd222-4c60-7003-9f01-f6d33d4be59f’)
Output
Get Cell
Get Cell
Get collection
Get collection
Slug:
HEX_GET_COLLECTIONTool 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.Input Parameters
Unique ID for a collection (UUID format). Example: 019cd222-11e7-7111-b40b-f40d81aba29b
Output
Get Group
Get Group
Get Project
Get Project
Get Project Runs
Get Project Runs
Slug:
HEX_GET_PROJECT_RUNSRetrieve a paginated list of API-triggered runs for a published Hex project, including execution status and timing. Runs can be filtered by status.Input Parameters
Offset for pagination. Use this to skip a certain number of results. Default is 0 if not specified.
Unique ID for a Hex project (UUID format). This is the project whose runs you want to retrieve.
Enum for run status values.
Output
Get Run Chart Image
Get Run Chart Image
Slug:
HEX_GET_RUN_CHART_IMAGETool to retrieve a rendered chart image from a Hex project run. Use when you need to get a visual representation of a chart cell from a completed run. Only supports chart-type cells that have executed successfully without errors. Rate limited to 20 requests per minute.Input Parameters
Static ID for the cell (UUID format). This is a stable identifier that remains consistent across project versions.
Output
Get Run Status
Get Run Status
Slug:
HEX_GET_RUN_STATUSTool 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.Input Parameters
Output
List Cells
List Cells
List Collections
List Collections
List Data Connections
List Data Connections
Slug:
HEX_LIST_DATA_CONNECTIONSList data connections in the Hex workspace with cursor-based pagination and sorting by name or creation date.Input Parameters
Pagination cursor for retrieving the next page of results. Obtained from the pagination object in the previous response.
Pagination cursor for retrieving the previous page of results. Obtained from the pagination object in the previous response.
Output
List groups
List groups
Slug:
HEX_LIST_GROUPSTool to list all groups in the Hex workspace with pagination support. Use when you need to retrieve groups with optional sorting and pagination.Input Parameters
Pagination cursor to retrieve the next page of results. Use the ‘after’ value from the previous response’s pagination object.
Number of results to return per page. Must be between 1 and 500. Defaults to 25 if not specified.
Pagination cursor to retrieve the previous page of results. Use the ‘before’ value from the previous response’s pagination object.
Output
List Hex Projects
List Hex Projects
List Users
List Users
Slug:
HEX_LIST_USERSTool 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.Input Parameters
Pagination cursor for fetching the next page of results. Use the cursor value returned in the previous response’s pagination object.
Pagination cursor for fetching the previous page of results. Use the cursor value returned in the previous response’s pagination object.
Filter users by group ID. When provided, returns only users that belong to the specified group.
Output
Publish Guide Drafts
Publish Guide Drafts
Slug:
HEX_PUBLISH_GUIDE_DRAFTSTool 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.Input Parameters
Set to true to publish all draft guides. When true, the orgGuideFileIds parameter is ignored.
Output
Run Project
Run Project
Slug:
HEX_RUN_PROJECTTool 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.Input Parameters
Perform dry run without executing project. Useful for validating inputs without running the project (default: false)
SavedView viewId to use for project run inputs. Allows running with a specific saved view configuration
Input parameters for project run as key/value pairs matching variable names defined in the project
Output
Update Cell
Update Cell
Update Project Status
Update Project Status
Slug:
HEX_UPDATE_PROJECTUpdate or remove a Hex project’s status, including endorsements. Omitting the status sends null, which removes the current status.Input Parameters
Status name to apply to the project (including endorsements). Set to null to remove the current status from the project.
Unique ID for the Hex project in UUID format (e.g., ‘019cd222-4c60-7003-9f01-f6d33d4be59f’)
Output
Upsert Guide Draft
Upsert Guide Draft
Slug:
HEX_UPSERT_GUIDE_DRAFTTool 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.Input Parameters
If true, overwrites existing guides even if they were synced from a different external source. Use with caution as this may overwrite content (default: false)