First Sync Complete Webhook

The FIRST_SYNC_COMPLETE webhook is sent when the initial data sync for an integration has finished. This event ensures your system has received an initial dataset from each group of models that are scheduled to be synced. Note that this may represent a subset of available data based on the configured sync schedule rather than a complete baseline of all possible data.

When It Triggers

You’ll receive one FIRST_SYNC_COMPLETE webhook for each sync schedule in your integration.

Default Configuration:
Most customers use a single sync schedule, which syncs all enabled data models on a set timing interval. In this case, you’ll receive a single webhook when the initial sync completes.

Multiple Sync Schedules:
In less-common cases, you could have multiple sync schedules configured. In that case, you’ll receive a separate webhook as each schedule completes its initial sync.

For example, with custom schedules like:

• Applicants syncing every 15 minutes
• Units and Listings syncing weekly

You’ll receive two webhooks - one when each schedule finishes its first sync.

Common Use Cases

• Kicking off first-time data processing flows, such as analytics, migrations, or initial reporting.

Example Payload

1
{
2
  "event": "FIRST_SYNC_COMPLETE",
3
  "failed_job_count": 0,
4
  "integration_id": "INTEGRATION_ID_003",
5
  "is_sync_finished": true,
6
  "job_schedule_id": "JOB_SCHEDULE_ID_001",
7
  "successful_job_count": 49,
8
  "vendor": "YARDI"
9
}