Skip to content

update read.completed.initial description #1587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattwbeard merged 2 commits into from
Dec 23, 2025
Merged

update read.completed.initial description #1587

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef4b0fa
Update migrating-to-new-event-types.md
mattwbeard May 28, 2025
b1311b0
Update docs/using-the-api/webhooks/migrating-to-new-event-types.md
pzaichkina Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/using-the-api/webhooks/migrating-to-new-event-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,7 +570,7 @@ When adopting the new schema, ensure that you handle all elements in the `dataTy

Called when initial syncs are complete for all data types queued for a newly connected company, and at least one of those syncs is successful.

The replacement `read.completed.initial` webhook is called the first time the data type is stored in Codat's cache and uses the same payload as the `read.completed` webhook.
The replacement `read.completed.initial` webhook is called when data is successfully read after each time a connection is authorized. Uses the same payload as the `read.completed` webhook.

:::tip Adopting the new schema
When adopting the new schema, ensure that you handle all elements in the `dataTypes` array to maintain future compatibility.
Expand Down
Loading