Project run

Description

This job triggers a project run in Hex using this endpoint.

Use Cases

We recommend creating a Project run task for every 'project' in Hex.

This way, you can use Orchestra to trigger your refreshes on a cron or event based schedule. This has a number of advantages vs. using Hex's in-built scheduler:

• You can co-ordinate tasks outside of Hex - these would typically be specific dbt job runs or operations that you know need to succeed before building your dashboards.

  • A common use-case is to have a dbt run job that transform the data so it is ready for Hex to use. This way, you can ensure data pushed to Hex adheres to data quality constraints.

• You can use Orchestra to trigger jobs across Hex accounts

• When Hex jobs run, cost is incurred. Running these operations on a schedule you set explicitly ensures these costs do not go out of hand

Parameters

These parameters are required to run the Project run task

Name	Data type	Restrictions	Example
Project Id	string	N.A.	random_project_i
Input params	JSON	JSON format	{ "arg": "dummy" }