Academy / Week 2 / Settings, Lifecycle & Sync Frequency / Customizing Sync Frequency with Schedulers

Customizing Sync Frequency with Schedulers

Lesson 10.4 ⏱ ~7 min Week 2

💡 Why This Matters

Schedulers are the actual mechanism for controlling how often each entity syncs in each integration. Knowing how to configure them correctly — and override the defaults — is an important implementation skill for new integrations.

🎯 What You'll Learn

  • Why spec.json sync frequency is not used and what Schedulers are
  • How Schedulers override the default SyncApp-wide sync frequency per entity per integration
  • How to implement a custom Scheduler in the SyncApp integration code
  • The relationship between Schedulers and the per-entity cron jobs discussed in Week 1 Module 5
  • Real-world scenarios where custom scheduler values are needed (slow APIs, throttled PMSs, infrequently-changing entities)

Watch Video

Open in Google Drive 💡 Open in Drive for AI-powered transcript search and summaries

📋 Lesson Summary

Schedulers are the correct tool for customizing sync frequency per entity in a specific integration. Each entity (patients, appointments, providers) can have its own scheduler instance with a custom interval, configured directly in the integration's Go code. The scheduler overrides the default SyncApp-wide sync frequency. This is the tool to use when an entity's data changes rarely (set a longer interval), when a PMS API is throttled (set a longer interval to avoid rate limits), or when critical data must sync more frequently. spec.json's sync frequency field is for the integrations dashboard — it doesn't reach the SyncApp runtime.

🏷 Key Concepts

SchedulersPer-Entity Sync Frequency OverrideDefault SyncApp FrequencyScheduler Implementation in GoRate Limit Management via SchedulerEntity-Level Customization

Key Takeaways

01Schedulers are the one and only tool for customizing sync frequency per entity in SyncApp
02Each entity gets its own scheduler instance — you can set appointments to sync every 5 minutes while providers sync every 24 hours
03When a PMS is throttling your API calls, the first fix is extending the scheduler interval for the high-frequency entities
04If no custom scheduler is set, the entity uses the SyncApp-wide default frequency
05Implement schedulers during integration development — don't defer this to post-production tuning