Academy / Week 2 / Settings, Lifecycle & Sync Frequency / spec.json and Sync Frequency

spec.json and Sync Frequency

Lesson 10.3 ⏱ ~7 min Week 2

πŸ’‘ Why This Matters

Many engineers assume spec.json controls sync frequency β€” it doesn't. Clearing this misconception early prevents incorrect configuration attempts and wasted debugging time.

🎯 What You'll Learn

  • What spec.json is: a per-integration metadata file consumed by the integrations dashboard, not the SyncApp
  • Why every integration has its own spec.json (Weave supports 90+ PMSs, no global spec possible)
  • What fields spec.json contains: integration name, version, sync frequency, entity list, etc.
  • The critical fact: SyncApp business logic does NOT read spec.json β€” including sync frequency in minutes
  • What the integrations dashboard uses spec.json for
  • Where sync frequency is actually controlled (teaser for the next lesson)

β–Ά Watch Video

Open in Google Drive πŸ’‘ Open in Drive for AI-powered transcript search and summaries

πŸ“‹ Lesson Summary

spec.json is a metadata file that exists per-integration in the SyncApp repo. With 90+ PMS integrations, each is too different for a global configuration file. spec.json contains integration name, version, sync frequency in minutes, entity list, and other metadata. However β€” crucially β€” none of this is read by SyncApp's business logic. The SyncApp does not use spec.json's sync frequency to decide how often to sync. spec.json is consumed by the integrations dashboard to display integration metadata. Actual sync frequency control in SyncApp uses a different mechanism: Schedulers.

🏷 Key Concepts

spec.jsonPer-Integration MetadataIntegrations DashboardSync Frequency Field (not used by SyncApp)90+ PMS IntegrationsEntity List in spec.jsonspec.json vs Scheduler

⭐ Key Takeaways

01spec.json's sync frequency field is for display purposes in the dashboard only β€” changing it does NOT affect how often SyncApp syncs
02Every integration must have its own spec.json β€” there is no global configuration file
03Keep spec.json accurate for dashboard consumers, but don't rely on it for runtime SyncApp behavior
04If you need to change sync frequency for an integration, use Schedulers β€” not spec.json