Trigger syncs with Airflow

​

Overview

​

Setup

​

Create an API key

1. From the API keys tab on the Settings page, click Add API key.
2. Enter a descriptive Name for your key.
3. Under User group, select the group whose permissions the key should have in this workspace, or select All of the creator’s groups to give the key the same permissions as you.
4. Copy your API key and store it in a safe location. The key is only displayed once.
5. Click Create API key.

​

Add the Airflow connection

1. In Airflow, create a new connection by going to Admin > Connections and clicking the + button to add a new connection.
2. Enter hightouch_default as the Conn ID, select HTTP as the Conn Type, and set the host to https://api.hightouch.com. Optionally, enter a Description.
3. Enter the API key you created in the Password field.

​

Set sync schedule type

​

Install the Airflow package

pip install airflow-provider-hightouch

​

Add the HightouchTriggerSyncOperator to your DAG

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
    )