update read.completed.initial description #1587
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattwbeard
requested review from
mcclowes,
dcoplowe and
pzaichkina
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Overall readability score: 58.07 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
|
Link check results (filtered): |
mcclowes
reviewed
Jun 5, 2025
| @@ -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. | |||
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Update description of read.completed.initial webhook to clarify it will trigger on each dataconnection linking
Type of change
Reviews and merging
You are responsible for getting your PR merged. Address review comments promptly and make sure to merge the PR when ready.
Feel free to 'Enable automerge' - your PR will automatically merge when accepted and passing the build.