WebhooksWebhook Details

Sync Complete Webhook

The SYNC_COMPLETE webhook is sent when a full data sync for an integration has finished. This event does not include the first sync, which is reported separately by the FIRST_SYNC_COMPLETE webhook.

When It Triggers

A SYNC_COMPLETE webhook is triggered after a periodic or on-demand full sync job finishes running for an integration. It is sent once all associated jobs for that sync cycle have either succeeded or failed.

Common Use Cases

  • Triggering post-sync processes such as report generation, downstream updates, or data exports.
  • Generating sync completion logs for monitoring integration performance and reliability.

Example Payload

1{
2 "event": "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}

Field Reference

  • failed_job_count – Number of jobs that failed during the sync.
  • integration_id – Unique ID for the integration.
  • is_sync_finished – Indicates whether the sync is fully complete.
  • job_schedule_id – The ID of the scheduled job that ran the sync.
  • successful_job_count – Number of jobs that completed successfully during the sync.
  • vendor – The PMS vendor for the integration.