Skip to content

Conversation

@mattwbeard
Copy link
Contributor

Description

Update description of read.completed.initial webhook to clarify it will trigger on each dataconnection linking

Type of change

  • updating existing

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.

@vercel
Copy link

vercel bot commented May 28, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
codat-docs Ready Ready Preview, Comment Dec 23, 2025 5:12pm

@mattwbeard mattwbeard enabled auto-merge May 28, 2025 12:21
@github-actions
Copy link

Overall readability score: 58.07 (🟢 +0)

File Readability
migrating-to-new-event-types.md 73.58 (🟢 +0)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
migrating-to-new-event-types.md 73.58 61.02 6.34 7.5 9.43 8.75
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 58.07 48.75 10.34 11.55 12.07 7.82
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

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
Contributor 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.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe this? @mattwbeard appreciate it's been MONTHS

The replacement read.completed.initial webhook is called when data is successfully read after each time a connection is authorized.

@cursor
Copy link

cursor bot commented Dec 23, 2025

You have run out of free Bugbot PR reviews for this billing cycle. This will reset on January 20.

To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

@github-actions
Copy link

Link check results for preview deployment (https://codat-docs-git-update-read-completed-initial-description-codat.vercel.app):

[
  "[404] https://codat-docs-git-update-read-completed-initial-description-codat.vercel.app/"
]

@mattwbeard mattwbeard merged commit 0e6e84b into main Dec 23, 2025
5 of 9 checks passed
@mattwbeard mattwbeard deleted the update-read.completed.initial-description branch December 23, 2025 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants