The first step is to create a Hightouch API key in your Hightouch workspace settings.
From the API keys tab on the Settings page, select Add API key.
Enter a descriptive Name for your key.
Copy your API key and store it in a safe location. The key will only be displayed once.
Click Create API key.
Your API key provides read/write access to sensitive Hightouch resources and should be kept secure. If you believe your API key may have been compromised, revoke it immediately.
For the Airflow extension to trigger syncs via the Hightouch API, you must set the syncs' schedules to Manual.
You can do this by going to the Syncs overview page, selecting the particular sync you want to trigger with Airflow, and opening the Schedule tab. Here, make sure the Schedule type is set to Manual. You should do this for each sync you want to trigger with Airflow.
You can also find the sync ID on this page, which you need for scheduling syncs in the next step.
The last step is to add the operator to a DAG and enter the sync ID of the sync you want to trigger. When the task is run, Airflow sends a call to the Hightouch API to trigger a run which completes asynchronously.
Alternatively, you can choose to send a synchronous request and await the results of the sync before completing the task.
from airflow_provider_hightouch.operators.hightouch \
import HightouchTriggerSyncOperator
with DAG(....) as dag:
...
# This task submits the request but doesn't wait for completion of the sync before completing.
my_async_task = HightouchTriggerSyncOperator(
task_id="run_my_sync", sync_id=1234
)
# This task waits for the sync status to complete or error before completing.# Warnings can be treated as errors or successes depending on your use case.
my_sync_task = HightouchTriggerSyncOperator(
task_id="run_sync", sync_id=1234, synchronous=True, error_on_warning=True
)
Ready to get started?
Jump right in or a book a demo. Your first destination is always free.