Configure Zuora to Limio Hot Sync
🎉 Available from release 109 onwards
What is hot sync?
In scenarios where no external data migration has occurred to pre-populate Limio with subscription data from systems like Zuora, Limio offers a hot sync feature. This allows Limio to dynamically retrieve subscription data during customer login and populate Limio in real time.
The process is triggered based on identity claims in the user’s authentication token and ensures that customers can view and manage their subscriptions as though they originated in Limio.
⚠️ This feature is particularly useful for staged migrations or hybrid data strategies where some users are migrated, and others are not.
How does it work?
When a user logs in, Limio scans their ID token for a specific claim containing the Zuora Account ID. If found, Limio initiates an asynchronous background sync with Zuora. This sync pulls in the user’s subscription data and updates Limio accordingly, similar to the existing that can be triggered via API or via a Zuora callout. The specific data synced is customer account data, subscription data, and payment method data (including the default payment method).
This process can repeat at every login to ensure consistency between Zuora and Limio. Each sync event generates an event object in Limio, which can be monitored in the Events section for transparency and error tracking. This greatly simplifies keeping the systems in sync.
How to configure hot sync
Step 1: Configure identity claims in Limio
Navigate to Settings > Authentication Providers.
Select the authentication provider you’ve configured (e.g. , ).
Setting up a new Identity Provider
Scroll to the Identity Claims section.
Add a claim with the field name set to the Zuora Account ID.
Ensure the claim is configured as follows:
Service:
zuoraIssuer:
zuoraType:
account
✅ If these values are incorrect, Limio will not detect the claim and the hot sync will not be triggered.
Limio Identity setup with Claims
Limio also supports multiple Zuora Account ID claims. If multiple matching claims exist, each account will be queued individually for sync.
Step 2: Enable hot sync in Limio Settings
Go to Settings > General Settings > Zuora > Zuora Sync Settings.
Enable the setting: Do you want to hot sync Zuora data into Limio when customers log in?
This is the main toggle that activates the hot sync functionality for all users.
Limio Settings for Hot Sync
🛑 It is currently not recommended to enable the sync options that automatically create Offers or Add-ons during hot sync. Learn more at
Step 3: View hot sync events
When Limio detects new subscriptions during login, it creates a sync event, which appears in the Events log. These events:
Are searchable and viewable in the Limio interface.
Provide real-time feedback on sync success or failure.
Can be treated similarly to orders for error handling and debugging
Example screenshot of an event is provided below.
Summary
By enabling and configuring hot sync:
Customers can access and manage existing Zuora subscriptions in Limio.
Subscriptions are automatically loaded based on ID token claims.
Syncs are repeated at each login for data consistency.
This approach enables a seamless, real-time integration between Limio Self-Service and Zuora, even in hybrid or staged migration scenarios.
For further questions or advanced configuration guidance, please .
Last updated
Was this helpful?

