Skip to main content
Hex logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 32
  • Triggers: 0
  • Slug: HEX
  • Version: 20261101_00

Tools

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

string
required
Unique ID for a run of a Hex project in UUID format. This identifies the specific run to cancel.
string
required
Unique ID for a Hex project in UUID format. This identifies the project that contains the run to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_CREATE_CELLTool 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.

Input Parameters

string
Optional label for the cell to make it easier to identify
string ("CODE" | "SQL")
required
Type of cell to create. Only CODE and SQL types are supported.
object
required
Cell contents. Must include codeCell.source for CODE type or sqlCell for SQL type.
object
Model for specifying where to place the cell in the project.
string
required
Unique ID for the Hex project (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_CREATE_COLLECTIONTool to create a new collection in the Hex workspace. Use when you need to organize projects and resources into a collection.

Input Parameters

string
required
Name for the collection
object
Model for collection sharing configuration.
string
Description of the collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_CREATE_GROUPTool to create a new group in the Hex workspace. Use when you need to organize users into groups for collaboration and access control.

Input Parameters

string
required
Name for the new group (must be non-empty)
object
Model for group members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_DEACTIVATE_USERDeactivate a Hex workspace user by ID. If the workspace uses Directory Sync, users are managed there rather than through the API.

Input Parameters

string
required
Unique ID for a user in UUID format (e.g., 019cd222-074d-7003-a83e-56a40e97b60b)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
required
Unique identifier for the cell to delete. Must be in UUID format (e.g., ‘019cd2fb-8a0d-7007-9870-c3999f91e95b’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_DELETE_GROUPDeletes a group from the Hex workspace. Use this when you need to permanently remove a group by its ID.

Input Parameters

string
required
Unique ID for a group in UUID format (e.g., 019cd2fb-44c5-7007-a1d5-8fbe7aa7dbf3)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_DELETE_GUIDE_DRAFTDeletes a guide draft by ID from Hex. Use this when you need to permanently remove a draft guide.

Input Parameters

string
required
Unique ID for a guide file in UUID format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_EDIT_COLLECTIONEdit a Hex collection’s name or description and submit sharing settings for users, groups, or the workspace. Use this to update collection metadata or request changes to its sharing configuration.

Input Parameters

string
New name for the collection (must be non-empty if provided)
object
Sharing configuration for users, groups, or workspace.
string
Description of the collection
string
required
Unique ID for the collection to edit (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_EDIT_GROUPEdit a Hex group’s name or add and remove users. If the workspace uses Directory Sync, groups are managed there rather than through the API.

Input Parameters

string
New name for the group. Must be non-empty if provided.
object
Model for group members configuration.
string
required
Unique ID for a group in UUID format (e.g., 019cd2fb-0a06-7006-a522-d36b008968c7)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

object
required
Sharing configuration with collections to add or remove
string
required
Unique ID for the Hex project (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

object
required
Sharing configuration specifying which groups to add or modify and their access levels
string
required
Unique ID for the Hex project in UUID format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

object
required
Sharing configuration with publicWeb and workspace access levels. Both fields are required.
string
required
Unique ID for a Hex project (UUID format). This is the project whose sharing settings will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

object
required
Sharing configuration with upsert.users array containing user access settings
string
required
Unique ID for the Hex project in UUID format (e.g., ‘019cd222-4c60-7003-9f01-f6d33d4be59f’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_GET_CELLTool 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.

Input Parameters

string
required
Unique ID for a cell in UUID format (e.g., ‘019cd222-7c1d-7003-97d6-b5fd42e48784’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
required
Unique ID for a collection (UUID format). Example: 019cd222-11e7-7111-b40b-f40d81aba29b

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_GET_GROUPTool 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.

Input Parameters

string
required
Unique ID for a group in UUID format (e.g., 019cd2fb-0a06-7006-a522-d36b008968c7)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_GET_PROJECTTool 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.

Input Parameters

string
required
Unique ID for a Hex project in UUID format
boolean
Include sharing information in the response (default: false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

integer
Number of results per page. Must be between 1 and 100. Default is 25 if not specified.
integer
Offset for pagination. Use this to skip a certain number of results. Default is 0 if not specified.
string
required
Unique ID for a Hex project (UUID format). This is the project whose runs you want to retrieve.
string ("PENDING" | "RUNNING" | "ERRORED" | "COMPLETED" | "KILLED" | "UNABLE_TO_ALLOCATE_KERNEL")
Enum for run status values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
required
Unique ID for the run of the Hex project (UUID format)
string
required
Static ID for the cell (UUID format). This is a stable identifier that remains consistent across project versions.
string
required
Unique ID for the Hex project (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
required
Unique ID for a run of a Hex project (UUID format)
string
required
Unique ID for a Hex project (UUID format)
string
Enable expanded statistics in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_LIST_CELLSTool 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.

Input Parameters

string
Pagination cursor for next page
integer
Number of results per page (1-100, default: 25)
string
Pagination cursor for previous page
string
required
Unique ID for a Hex project (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_LIST_COLLECTIONSTool to retrieve all collections in the workspace with pagination support. Use when you need to list or discover available collections.

Input Parameters

string
Pagination cursor for retrieving the next page of results
integer
Maximum number of collections to return per page (1-100, default: 25)
string
Pagination cursor for retrieving the previous page of results
string ("NAME")
Sort field enumeration for collections.
string ("ASC" | "DESC")
Sort direction enumeration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_LIST_DATA_CONNECTIONSList data connections in the Hex workspace with cursor-based pagination and sorting by name or creation date.

Input Parameters

string
Pagination cursor for retrieving the next page of results. Obtained from the pagination object in the previous response.
integer
Number of results to return per page. Must be between 1 and 100. Default is 25.
string
Pagination cursor for retrieving the previous page of results. Obtained from the pagination object in the previous response.
string ("CREATED_AT" | "NAME")
Enum for sort field options.
string ("DESC" | "ASC")
Enum for sort direction options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
Pagination cursor to retrieve the next page of results. Use the ‘after’ value from the previous response’s pagination object.
integer
Number of results to return per page. Must be between 1 and 500. Defaults to 25 if not specified.
string
Pagination cursor to retrieve the previous page of results. Use the ‘before’ value from the previous response’s pagination object.
string ("CREATED_AT" | "NAME")
Sort field options for groups listing.
string ("DESC" | "ASC")
Sort direction options for groups listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_LIST_PROJECTSTool 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.

Input Parameters

string
Pagination cursor for fetching the next page of results
integer
Number of results per page (1-100, default: 25)
string
Pagination cursor for fetching the previous page of results
string ("CREATED_AT" | "LAST_EDITED_AT" | "LAST_PUBLISHED_AT")
Sort field options for project listing.
array
Filter projects by one or more statuses
array
Filter projects by one or more categories
string
Filter projects by owner email address
string
Filter projects by collection ID
string
Filter projects by creator email address
string ("DESC" | "ASC")
Sort direction options.
boolean
Include sharing information for each project (default: false)
boolean
Include trashed projects in the results (default: false)
boolean
Include archived projects in the results (default: false)
boolean
Include component projects in the results (default: false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
Pagination cursor for fetching the next page of results. Use the cursor value returned in the previous response’s pagination object.
integer
Number of results per page. Must be between 1 and 500. Default is 25.
string
Pagination cursor for fetching the previous page of results. Use the cursor value returned in the previous response’s pagination object.
string ("NAME" | "EMAIL")
Sort field options for user listing.
string
Filter users by group ID. When provided, returns only users that belong to the specified group.
string ("DESC" | "ASC")
Sort direction options for user listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

array
List of specific guide IDs to publish. Ignored if publishAllDraftGuides is true.
boolean
Set to true to publish all draft guides. When true, the orgGuideFileIds parameter is ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

boolean
Perform dry run without executing project. Useful for validating inputs without running the project (default: false)
string
SavedView viewId to use for project run inputs. Allows running with a specific saved view configuration
string
required
Unique ID for the Hex project (UUID format)
object
Input parameters for project run as key/value pairs matching variable names defined in the project
array
List of notification details for Slack/users/groups to notify when the run completes
string
Flag configuration override for feature flags
boolean
Use cached SQL results from previous runs when available (default: true)
boolean
Update cached state of published app after successful run (default: false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEX_UPDATE_CELLTool 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.

Input Parameters

string
required
Unique identifier for the cell to update (UUID format)
object
Model for cell contents with either code or SQL cell data.
string
Data connection ID for SQL cells (UUID format or null to remove connection)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
Status name to apply to the project (including endorsements). Set to null to remove the current status from the project.
string
required
Unique ID for the Hex project in UUID format (e.g., ‘019cd222-4c60-7003-9f01-f6d33d4be59f’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

array
required
Array of guide files to create or update. Each file must have a filePath and contents
boolean
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)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not