Event-Based Notifications & CDC
Gormic provides a unified change tracking system to help external systems stay in sync with your data. This system supports both:
CDC Logs: Pull-based access to historical change events.
Event-Based Notifications: Real-time push via webhooks.
Both mechanisms operate over a shared, abstract interface, allowing integrators to track changes across modules like Orders, Products, Customers, and more.
How It Works
Each module that supports change tracking is identified by a log key (e.g., main, transactional
). You can either:
Pull changes manually from the log (
pullChanges
endpoint)Subscribe to receive webhooks in real time for selected actions
This enables flexible sync patterns for both batch systems and real-time integrations.
Pull-Based Change Log (CDC)
Use the pullChanges
API to manually fetch change events for a specific log key.
Parameters:
logKey
The log key to track (e.g., main
, transactional
)
offset
Cursor returned from the previous pull. Start with "0"
or latest offset.
Use the
next
value as the offset in your next request.Continue pulling until
next
is not present.
Event-Based Notifications (Webhooks)
For real-time integration, you can subscribe to webhook notifications triggered by changes in supported modules.
Parameters
logKey
The log key to track(e.g., main
, transactional
)
action
optional. Example: create
, update
, delete
url
The public URL where events should be delivered
token
Bearer token used to sign the request for auth
Last updated
Was this helpful?