This repository has been archived by the owner on Mar 10, 2024. It is now read-only.
feat: sync states for webhook sync.complete #2018
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For customers with SyncConfig (and not ConnectionSyncConfig), ObjectSyncs loosely start simultaneously. Using that, we can emit all sync states as part of the sync.complete webhook so they know if other syncs have been
finished
, which allows them to see if they can process an object that depends on another, e.g., Accounts before Contacts, without storing additional state on their side.syncedRecordsUpToWatermark
is also included for "full then incremental" syncs in the payload so they can process objects up to a specific watermark if needed.Note: this isn't foolproof, e.g., in situations where the longest sync time runs up against the sync frequency
Test Plan
Tested locally
sync.complete webhook event
Deployment instructions
[Add any special deployment instructions here]