Hex and Zapier connect so you can monitor projects, workspace members, and runs; run published projects; manage sharing and groups; and embed published work in other tools.
Prerequisites
To use the Hex app on Zapier, you must have:
- A Hex account with API access.
- An API token for your Hex account.
Find your Hex API token
Create or copy an API token in Hex API keys settings.
Connect Hex to Zapier
To create an app connection to Hex on Zapier:
- Go to the Apps page.
- Click + Add connection.
- A new dialog box will appear. Search for and select Hex.
- Click Add connection.
- A Connect an Account page will open in a browser tab or window.
- In the API Token field, enter your Hex API token.
- Click Yes, Continue to Hex (or the button shown to finish the connection).
Your Hex account is now successfully connected to Zapier.
About Hex's app
Triggers, searches, and actions
Triggers
- List Groups (Polling) - Triggers when a group is found in your Hex workspace.
- List Projects (Polling) - Triggers when a project is found in your Hex workspace.
- List Users (Polling) - Triggers when a user is found in your Hex workspace.
- New Project Run (Polling) - Triggers when a new API-triggered run appears for a Hex project.
Searches
- Get Project - Retrieves metadata about a specific Hex project.
- Get Project Runs - Retrieves the run history for a Hex project, optionally filtered by status.
- Get Run Status - Retrieves the current status of a Hex project run.
Actions
- Cancel Run - Cancels an in-progress Hex project run.
- Create Embed URL - Creates a presigned URL to embed a published Hex project.
- Create Group - Creates a new group in your Hex workspace.
- Create Project - Creates a new Hex project.
- Run Project - Triggers execution of a published Hex project.
- Share Project With Groups - Shares a Hex project with one or more groups at a specified access level.
- Share Project With Users - Shares a Hex project with one or more users at a specified access level.
- Update Project Status - Updates the status of a Hex project (or removes it).
Limitations
- New Project Run only surfaces runs that are API-triggered for the project you select in the trigger.