Search documentation...

ChangelogBook a demoSign up

Trigger syncs with Prefect


Prefect provides native tasks to interact with Hightouch. Check out the Git repository for examples and Prefect's API reference for usage details.


To use Prefect's tasks you need:

  • A Hightouch API key
  • The sync IDs of the syncs you want to trigger using Prefect

Create an API key

The first step is to create a Hightouch API key in your Hightouch workspace settings.

  1. From the API keys tab on the Settings page, select Add API key.
  2. Enter a descriptive Name for your key.
  3. Copy your API key and store it in a safe location. The key will only be displayed once.
  4. 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.

Set sync schedule type

For the Prefect 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 Prefect, 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 Prefect.

Manual sync Hightouch UI

You can also find the sync ID on this page, which you need for scheduling syncs in the next step.

A sync ID in the Hightouch UI


Refer to Prefect's Hightouch Git repository for the most up-to-date examples and instructions.

Ready to get started?

Jump right in or a book a demo. Your first destination is always free.

Book a demoSign upBook a demo

Need help?

Our team is relentlessly focused on your success. Don't hesitate to reach out!

Feature requests?

We'd love to hear your suggestions for integrations and other features.

Last updated: Feb 7, 2023

On this page

OverviewSetupCreate an API keySet sync schedule typeUsage

Was this page helpful?