syncs
Installation
SKILL.md
What it is
A sync keeps records equal between two apps, such as a CRM and a database. It holds one or more
table pairs, each with mapped fields and a direction: both, app_1_to_app_2 or
app_2_to_app_1. One sync can hold two-way and one-way pairs side by side. A sync lives in one
region, besg (Europe) or usnv (United States), the region of its two connections.
A sync also carries sync event triggers (an HTTP call, a database query or a queue message when a synced record is created, updated or deleted) and sync webhooks (notifications about the sync itself).
When to use it
- Records must stay equal in two apps, continuously, in one or both directions.
- A record change in a synced app must call an API, run SQL or feed a queue.
- A URL must be told about a sync's activity, failed records or first copy of the data.
Use a workflow instead for multi-step logic on each record, and connectors for a one-off action
in an app. When a sync has failed records or stopped, follow the runbook troubleshooting-a-sync.