Academy / Week 3 / SyncApp Code Flow & Creating a New Integration / Code Flow Part 3 — Integration Structure & Scheduler Config

Code Flow Part 3 — Integration Structure & Scheduler Config

Lesson 13.3⏱ ~9 minWeek 3

💡 Why This Matters

Knowing the full integration structure — default functions, custom functions, and how to register and schedule them — is what you need before you can create your first new integration from scratch.

🎯 What You'll Learn

  • What default sync functions are: functions that every integration gets for free
  • How to add custom sync functions for integration-specific data beyond the defaults
  • How to register a new sync function using the registration pattern
  • Scheduler configuration: min 15 minutes, max configurable to run less frequently (once/twice/four times a day)
  • Why setting a scheduler to 400 times per day doesn't work — the 15-minute floor is enforced
  • The overall integration structure: one folder per PMS, each containing API + entity + sync layers

Watch Video

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

📋 Lesson Summary

Every integration has access to default sync functions (for standard entities like patients and appointments). Beyond defaults, you can implement and register custom functions for integration-specific entities. Scheduler configuration controls frequency: the minimum is 15 minutes (enforced in code — you can't go lower). You can configure it to run less frequently: once, twice, or four times a day. Setting an unrealistic number (400 times/day) silently falls back to the 15-minute minimum. Each integration lives in its own folder in the SyncApp repo, containing an API package, an entity package, and the sync method implementations.

🏷 Key Concepts

Default Sync FunctionsCustom Sync FunctionsFunction RegistrationScheduler Configuration15-Minute MinimumIntegration Folder StructureAPI PackageEntity PackageSync Method

Key Takeaways

01Default functions are free — only implement custom ones for PMS-specific data not covered by defaults
02The 15-minute floor is hard-coded — there's no way to make SyncApp sync more frequently than this
03Register every custom sync function or it won't run — registration is not automatic
04One folder per integration in the SyncApp repo — don't put integration-specific code in shared packages
05Configure scheduler frequency based on data change rate and PMS API limits, not just preference