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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update read.completed.initial description #1587

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 the first time a sync is completed after a data connection is linked. Uses the same payload as the `read.completed` webhook.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The replacement `read.completed.initial` webhook is called the first time a sync is completed after a data connection is linked. Uses the same payload as the `read.completed` webhook.
The replacement `read.completed.initial` webhook is called when a connection is authorized and data is read for the first time. Uses the same payload as the `read.completed` webhook.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The webhook triggers each time the dataconnection is set to linked, not just the first time

How about:
The replacement read.completed.initial webhook is called when data is successfully read after a connection is authorized.


:::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