Hex

hex

Hex is a collaborative data workspace that combines SQL, Python, and R notebooks for analytics and data science

Analytics Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (31)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Cancel RunHEX_CANCEL_RUNAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CellHEX_CREATE_CELLAcción

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.

Parámetros de entrada

labelstring
Optional label for the cell to make it easier to identify
cellTypestringObligatorioenum
Type of cell to create. Only CODE and SQL types are supported.
CODESQL
contentsobjectObligatorio
Cell contents. Must include codeCell.source for CODE type or sqlCell for SQL type.
locationobject
Model for specifying where to place the cell in the project.
projectIdstringObligatorio
Unique ID for the Hex project (UUID format)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CollectionHEX_CREATE_COLLECTIONAcción

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

Parámetros de entrada

namestringObligatorio
Name for the collection
sharingobject
Model for collection sharing configuration.
descriptionstring
Description of the collection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create GroupHEX_CREATE_GROUPAcción

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

Parámetros de entrada

namestringObligatorio
Name for the new group (must be non-empty)
membersobject
Model for group members.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Deactivate UserHEX_DEACTIVATE_USERAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete CellHEX_DELETE_CELLAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete GroupHEX_DELETE_GROUPAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Guide DraftHEX_DELETE_GUIDE_DRAFTAcción

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

Parámetros de entrada

orgGuideFileIdstringObligatorio
Unique ID for a guide file in UUID format

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit CollectionHEX_EDIT_COLLECTIONAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit GroupHEX_EDIT_GROUPAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit Project Sharing CollectionsHEX_EDIT_PROJECT_SHARING_COLLECTIONSAcción

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.

Parámetros de entrada

sharingobjectObligatorio
Sharing configuration with collections to add or remove
projectIdstringObligatorio
Unique ID for the Hex project (UUID format)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit Project Sharing GroupsHEX_EDIT_PROJECT_SHARING_GROUPSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit Project Sharing SettingsHEX_EDIT_PROJECT_SHARING_ORG_AND_PUBLICAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit Project Sharing UsersHEX_EDIT_PROJECT_SHARING_USERSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CellHEX_GET_CELLAcción

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.

Parámetros de entrada

cellIdstringObligatorio
Unique ID for a cell in UUID format (e.g., '019cd222-7c1d-7003-97d6-b5fd42e48784')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get collectionHEX_GET_COLLECTIONAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get GroupHEX_GET_GROUPAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ProjectHEX_GET_PROJECTAcción

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.

Parámetros de entrada

project_idstringObligatorio
Unique ID for a Hex project in UUID format
include_sharingboolean
Include sharing information in the response (default: false)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project RunsHEX_GET_PROJECT_RUNSAcción

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.

Parámetros de entrada

limitinteger
Number of results per page. Must be between 1 and 100. Default is 25 if not specified.
offsetinteger
Offset for pagination. Use this to skip a certain number of results. Default is 0 if not specified.
projectIdstringObligatorio
Unique ID for a Hex project (UUID format). This is the project whose runs you want to retrieve.
statusFilterstringenum
Enum for run status values.
PENDINGRUNNINGERROREDCOMPLETEDKILLEDUNABLE_TO_ALLOCATE_KERNEL

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Run StatusHEX_GET_RUN_STATUSAcción

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.

Parámetros de entrada

runIdstringObligatorio
Unique ID for a run of a Hex project (UUID format)
projectIdstringObligatorio
Unique ID for a Hex project (UUID format)
enable_expanded_statsstring
Enable expanded statistics in the response

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CellsHEX_LIST_CELLSAcción

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.

Parámetros de entrada

afterstring
Pagination cursor for next page
limitinteger
Number of results per page (1-100, default: 25)
beforestring
Pagination cursor for previous page
projectIdstringObligatorio
Unique ID for a Hex project (UUID format)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CollectionsHEX_LIST_COLLECTIONSAcción

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

Parámetros de entrada

afterstring
Pagination cursor for retrieving the next page of results
limitinteger
Maximum number of collections to return per page (1-100, default: 25)
beforestring
Pagination cursor for retrieving the previous page of results
sortBystringenum
Sort field enumeration for collections.
NAME
sortDirectionstringenum
Sort direction enumeration.
ASCDESC

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Data ConnectionsHEX_LIST_DATA_CONNECTIONSAcción

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.

Parámetros de entrada

afterstring
Pagination cursor for retrieving the next page of results. Obtained from the pagination object in the previous response.
limitinteger
Number of results to return per page. Must be between 1 and 100. Default is 25.
beforestring
Pagination cursor for retrieving the previous page of results. Obtained from the pagination object in the previous response.
sortBystringenum
Enum for sort field options.
CREATED_ATNAME
sortDirectionstringenum
Enum for sort direction options.
DESCASC

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List groupsHEX_LIST_GROUPSAcción

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

Parámetros de entrada

afterstring
Pagination cursor to retrieve the next page of results. Use the 'after' value from the previous response's pagination object.
limitinteger
Number of results to return per page. Must be between 1 and 500. Defaults to 25 if not specified.
beforestring
Pagination cursor to retrieve the previous page of results. Use the 'before' value from the previous response's pagination object.
sortBystringenum
Sort field options for groups listing.
CREATED_ATNAME
sortDirectionstringenum
Sort direction options for groups listing.
DESCASC

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Hex ProjectsHEX_LIST_PROJECTSAcción

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.

Parámetros de entrada

afterstring
Pagination cursor for fetching the next page of results
limitinteger
Number of results per page (1-100, default: 25)
beforestring
Pagination cursor for fetching the previous page of results
sortBystringenum
Sort field options for project listing.
CREATED_ATLAST_EDITED_ATLAST_PUBLISHED_AT
statusesstring[]
Filter projects by one or more statuses
categoriesstring[]
Filter projects by one or more categories
ownerEmailstring
Filter projects by owner email address
collectionIdstring
Filter projects by collection ID
creatorEmailstring
Filter projects by creator email address
sortDirectionstringenum
Sort direction options.
DESCASC
includeSharingboolean
Include sharing information for each project (default: false)
includeTrashedboolean
Include trashed projects in the results (default: false)
includeArchivedboolean
Include archived projects in the results (default: false)
includeComponentsboolean
Include component projects in the results (default: false)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List UsersHEX_LIST_USERSAcción

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.

Parámetros de entrada

afterstring
Pagination cursor for fetching the next page of results. Use the cursor value returned in the previous response's pagination object.
limitinteger
Number of results per page. Must be between 1 and 500. Default is 25.
beforestring
Pagination cursor for fetching the previous page of results. Use the cursor value returned in the previous response's pagination object.
sortBystringenum
Sort field options for user listing.
NAMEEMAIL
groupIdstring
Filter users by group ID. When provided, returns only users that belong to the specified group.
sortDirectionstringenum
Sort direction options for user listing.
DESCASC

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Publish Guide DraftsHEX_PUBLISH_GUIDE_DRAFTSAcción

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.

Parámetros de entrada

orgGuideFileIdsstring[]
List of specific guide IDs to publish. Ignored if publishAllDraftGuides is true.
publishAllDraftGuidesboolean
Set to true to publish all draft guides. When true, the orgGuideFileIds parameter is ignored.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Run ProjectHEX_RUN_PROJECTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update CellHEX_UPDATE_CELLAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Project StatusHEX_UPDATE_PROJECTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upsert Guide DraftHEX_UPSERT_GUIDE_DRAFTAcción

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.

Parámetros de entrada

filesobject[]Obligatorio
Array of guide files to create or update. Each file must have a filePath and contents
forceWriteboolean
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)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not