The first step is to create an API Token in your workspace settings. Once you click the Create API Key button, you'll be prompted for a name and presented with an API key. You'll need to save this key and enter it in the Airflow connections window as shown in the next step.
In Airflow, create a new connection by going to Admin > Connections and clicking the + to add a new connection. Name the connection
hightouch_default and set the host to
Enter the token from Step 1 in the Password field
Within the Hightouch Sync page, click the sync you wish to trigger. Your browser will display a url with the sync id. You'll use this when writing your Airflow DAG.
While the details will vary for your particular Airflow installation, the simplest way to install our package is through pip
pip install airflow-provider-hightouch
The last step is to add the operator to a DAG and add the Sync ID from Step 3. When the task is run, Airflow will send a call to the Hightouch API to trigger a run which will complete asynchronously.
from airflow_provider_hightouch.operators.hightouch \import HightouchTriggerSyncOperatorwith DAG(....) as dag:...my_task = HightouchTriggerSyncOperator(task_id="run_my_sync", sync_id=1234)
If you have any questions or issues, feel free to reach out via the Chat window, Github issues, or email. We welcome feedback and feature requests!