← Tools Reference

Hex

Hex integration (Data, Developer Tools). Imported from open-connector.

API key6 toolshttps://app.hex.tech/api/v1
GET
hex_list_projects
List Hex projects visible to the connected token, with pagination and common project filters.

/projects

14 parameters
ParamTypeRequiredDescription
limitintegeroptionalNumber of results to return.
afterstringoptionalPagination cursor returned by Hex.
beforestringoptionalPagination cursor returned by Hex.
sortBystringoptionalField used to sort Hex projects.
sortDirectionstringoptionalSort direction accepted by Hex.
statusesarrayoptionalProject statuses to include.
categoriesarrayoptionalProject categories to include.
ownerEmailstringoptionalOwner email address used to filter projects.
creatorEmailstringoptionalCreator email address used to filter projects.
collectionIdstringoptionalCollection ID used to filter projects.
includeSharingbooleanoptionalWhether to include sharing information for each project.
includeArchivedbooleanoptionalWhether to include archived projects.
includeTrashedbooleanoptionalWhether to include trashed projects.
includeComponentsbooleanoptionalWhether to include component projects.
GET
hex_get_project
Get metadata for a single Hex project by project ID.

/projects/{projectId}

2 parameters
ParamTypeRequiredDescription
projectIdstringrequiredUnique ID for a Hex project.
includeSharingbooleanoptionalWhether to include sharing information in the response.
POST
hex_run_project
Trigger a run of the latest published version of a Hex project.

/projects/{projectId}/runs

8 parameters
ParamTypeRequiredDescription
projectIdstringrequiredUnique ID for a Hex project.
inputParamsobjectoptionalInput parameters for the Hex project run, keyed by project variable name.
notificationsarrayoptionalNotifications to send when the run completes.
dryRunbooleanoptionalWhether to validate run inputs without executing the project.
updatePublishedResultsbooleanoptionalWhether to update the cached state of the published app after a successful run.
useCachedSqlResultsbooleanoptionalWhether to use cached SQL results when available.
viewIdstringoptionalSaved view ID to use for project run inputs.
flagConfigOverridestringoptionalFeature flag configuration override for the run.
GET
hex_list_project_runs
List API-triggered runs for a Hex project, optionally filtered by status.

/projects/{projectId}/runs

4 parameters
ParamTypeRequiredDescription
projectIdstringrequiredUnique ID for a Hex project.
limitintegeroptionalNumber of results to return.
offsetintegeroptionalNumber of runs to skip before returning results.
statusFilterstringoptionalHex project run status.
GET
hex_get_run_status
Get the status and metadata for a specific Hex project run.

/projects/{projectId}/runs/{runId}

3 parameters
ParamTypeRequiredDescription
projectIdstringrequiredUnique ID for a Hex project.
runIdstringrequiredUnique ID for a run of a Hex project.
enableExpandedStatsbooleanoptionalWhether to request expanded run statistics from Hex.
DELETE
hex_cancel_run
Cancel an in-progress Hex project run.

/projects/{projectId}/runs/{runId}

2 parameters
ParamTypeRequiredDescription
projectIdstringrequiredUnique ID for a Hex project.
runIdstringrequiredUnique ID for a run of a Hex project.