Hightouch Syncs API
Syncs, sync runs, sync sequences and their triggers.
Operations 13
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I see the mapping and schedule of one sync by its ID?”
“Is a particular Hightouch sync currently disabled?”
Tell an agent
Get sync {syncId}.
Show the schedule and mappings of sync {syncId}.
Ask an LLM
“Can I pause an existing sync by disabling it?”
“How do I change the schedule on a sync I already set up?”
Tell an agent
Disable sync {syncId} ({disabled}).
Change the schedule of sync {syncId} to {schedule}.
Ask an LLM
“Which syncs are set up in my workspace?”
“Can I list only the syncs that use a particular model?”
Tell an agent
List all syncs in my workspace.
List the syncs built on model {modelId}.
Ask an LLM
“How do I set up a new sync that sends a model's rows to a destination?”
“Can I create a sync in a disabled state and turn it on later?”
Tell an agent
Create sync {slug} from model {modelId} to destination {destinationId} with configuration {configuration}, schedule {schedule}, disabled {disabled}.
Set up a new sync {slug} sending model {modelId} to {destinationId} on schedule {schedule}, mapping {configuration}, disabled={disabled}.
Ask an LLM
“Did my sync run successfully in the last hour?”
“How do I see the past runs of a specific sync?”
Tell an agent
List the runs of sync {syncId}.
Show runs of sync {syncId} started within the last {within} minutes.
Ask an LLM
“How do I kick off a sync run immediately using the sync's ID in the path?”
“Can I force a full resync that ignores previously synced rows?”
Tell an agent
Trigger sync {syncId} now.
Run a full resync of sync {syncId} ({fullResync}).
Ask an LLM
“Can I trigger a sync using its slug instead of its numeric ID?”
“Is there a global trigger endpoint that takes the sync identifier in the body?”
Tell an agent
Trigger the sync with slug {syncSlug}.
Run the sync identified by {syncId} through the global trigger endpoint.
Documentation
Documentation
https://hightouch.com/docs
APIReference
https://hightouch.com/docs/api-reference
GettingStarted
https://hightouch.com/docs/getting-started/welcome