Skip to content
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

Jump to bottom

New webhooks documentation #1024

Merged
merged 14 commits into from
Mar 4, 2024
Merged

New webhooks documentation #1024

merged 14 commits into from
Mar 4, 2024

Conversation

pzaichkina
Copy link
Collaborator

Description

  • Include a summary of the new content you're adding or the reason for the change.
  • Include relevant context.
  • Do not link to work items.
  • Any PNG images should be compressed using Tiny PNG or equivalent.

Type of change

Please delete options that are not relevant.

  • New document(s)/updating existing
  • Fixes
  • Styling
  • Bug fix (non-breaking change which fixes an issue)

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 Vercel
Copy link

vercel bot commented Feb 21, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
codat-docs ✅ Ready (Inspect) Visit Preview ✅ 1 resolved Mar 4, 2024 2:43pm

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 21, 2024 •
edited
Loading

Overall readability score: 63.23 (🟢 +0.3)

File Readability
authorize-hosted-link.md 63.31 (🟢 +0)
build-your-own-authorization-journey.md 60.39 (🔴 -0.38)
pushing-transactions.md 59.11 (🔴 -0.46)
setup.md 48.74 (🟢 +0)
user-roles.md 57.8 (🔴 -1.98)
overview.md 56.12 (🔴 -0.33)
faq.md 4.45 (🟢 +0)
getting-started.md 43.59 (🟢 +0)
syncing-expenses.md 51.84 (🟢 +0)
checkpoints-app-store.md 58.9 (🔴 -0.29)
checkpoints-lending.md 54.72 (🔴 -2.12)
accounts-payable-overview.md 100 (🟢 +0)
accounts-receivable-overview.md 100 (🟢 +0)
bank-statements-overview.md 100 (🟢 +0)
financial-statements-overview.md 100 (🟢 +0)
liabilities-overview.md 100 (🟢 +0)
sales-overview.md 100 (🟢 +0)
get-started.md 79.41 (🟢 +0)
get-started.md 42.64 (🟢 +0)
bank-feeds.md 68.92 (🟢 +0.5)
implementing-a-mapping-page.md 54.91 (🔴 -1.19)
optimizing-api-calls.md 75.36 (🔴 -0.8)
push.md 51.9 (🔴 -0.31)
queueing-data-syncs.md 73.92 (🟢 +0)
rate-limits.md 70.55 (🟢 +0)
testing.md 95.44 (🟢 +0)
create-consumer.md 100 (-)
event-types.md 64.13 (-)
core-rules-create.md 81.7 (🔴 -0.57)
core-rules-types.md 57.41 (🟢 +0)
core-rules-webhooks.md 63.72 (🟢 +1.7)
core-rules-webhooksecurity.md 62.14 (🟢 +1.92)
receive-webhooks-as-email.md 64.89 (🟢 +1.08)
migration-guide.md 100 (-)
overview.md 100 (-)
troubleshooting.md 100 (-)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
authorize-hosted-link.md 63.31 51.78 10.9 11.4 10.56 6.78
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
build-your-own-authorization-journey.md 60.39 46.17 10.24 11.3 11.6 7.34
  🔴 -0.38 🟢 +0 🔴 -0.05 🔴 -0.1 🔴 -0.06 🔴 -0.02
pushing-transactions.md 59.11 54.02 10.54 11.9 12.06 7.51
  🔴 -0.46 🟢 +0.1 🟢 +0.01 🔴 -0.1 🔴 -0.29 🟢 +0.02
setup.md 48.74 57.27 11.31 10.5 12.35 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
user-roles.md 57.8 37.5 10.29 11.5 11.95 7.43
  🔴 -1.98 🔴 -0.1 🔴 -0.36 🔴 -0.2 🔴 -0.29 🔴 -0.2
overview.md 56.12 47.08 10.97 11.4 12.47 7.9
  🔴 -0.33 🔴 -0.1 🔴 -0.09 🟢 +0 🟢 +0 🔴 -0.05
faq.md 4.45 6.5 17.03 22 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
getting-started.md 43.59 43.39 13.49 11.5 14.77 9.21
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
syncing-expenses.md 51.84 44.71 12.16 8.6 11.63 10.11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
checkpoints-app-store.md 58.9 46.27 10.24 11.7 12.35 7.3
  🔴 -0.29 🔴 -0.1 🔴 -0.07 🟢 +0 🔴 -0.06 🔴 -0.02
checkpoints-lending.md 54.72 39.23 10.08 12.1 13.27 7.74
  🔴 -2.12 🔴 -8.56 🔴 -0.08 🔴 -0.2 🔴 -0.17 🔴 -0.01
accounts-payable-overview.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
accounts-receivable-overview.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
bank-statements-overview.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
financial-statements-overview.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
liabilities-overview.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
sales-overview.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
get-started.md 79.41 79.26 6 6 8.03 9.35
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
get-started.md 42.64 42.88 13.3 12.2 15.35 9.01
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
bank-feeds.md 68.92 56.15 9.24 10.1 10.84 6.61
  🟢 +0.5 🟢 +0.2 🟢 +0.1 🟢 +0.2 🟢 +0 🟢 +0
implementing-a-mapping-page.md 54.91 45.66 11.28 12.2 12.53 7.65
  🔴 -1.19 🔴 -0.1 🔴 -0.17 🔴 -0.2 🔴 -0.24 🔴 -0.08
optimizing-api-calls.md 75.36 63.39 9.12 8.4 8.47 6.85
  🔴 -0.8 🔴 -0.2 🔴 -0.19 🔴 -0.2 🔴 -0.06 🔴 -0.02
push.md 51.9 42.31 12.08 13.4 12.13 7.62
  🔴 -0.31 🔴 -0.1 🔴 -0.06 🟢 +0 🟢 +0 🔴 -0.06
queueing-data-syncs.md 73.92 75.88 6 6.5 7.25 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
rate-limits.md 70.55 66.4 10 6 6 10.2
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
testing.md 95.44 83.32 6 6 7.28 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
create-consumer.md 100 100 6 6 6 4.9
  - - - - - -
event-types.md 64.13 64.71 8.67 7.7 8.4 11
  - - - - - -
core-rules-create.md 81.7 66.74 7.2 7 8.05 6.89
  🔴 -0.57 🔴 -0.1 🔴 -0.15 🔴 -0.2 🔴 -0.23 🟢 +0.1
core-rules-types.md 57.41 45.35 10.19 13.2 12.18 7.14
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
core-rules-webhooks.md 63.72 55.95 10.24 9.9 10.37 7.98
  🟢 +1.7 🟢 +0.21 🟢 +0.2 🟢 +0.2 🟢 +0.3 🟢 +0.19
core-rules-webhooksecurity.md 62.14 42.78 8.88 9.3 11.35 8.36
  🟢 +1.92 🔴 -0.2 🟢 +0.12 🟢 +0.1 🟢 +0.29 🟢 +0.37
receive-webhooks-as-email.md 64.89 46.78 9.23 10.2 10.73 7.39
  🟢 +1.08 🟢 +0.41 🟢 +0.15 🟢 +0.3 🟢 +0 🟢 +0.1
migration-guide.md 100 100 6 6 6 4.9
  - - - - - -
overview.md 100 100 6 6 6 4.9
  - - - - - -
troubleshooting.md 100 100 6 6 6 4.9
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 63.23 53.57 9.72 10.77 11.36 7.47
  🟢 +0.3 🟢 +0.38 🟢 +0.03 🟢 +0.05 🟢 +0.05 🟢 +0.02
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

@pzaichkina pzaichkina marked this pull request as ready for review February 22, 2024 21:29
dcoplowe
dcoplowe approved these changes Feb 23, 2024
View reviewed changes
docs/using-the-api/webhooks/event-types.md Outdated Show resolved Hide resolved
docs/using-the-api/webhooks/create-consumer.md Outdated Show resolved Hide resolved
docs/using-the-api/webhooks/create-consumer.md

A webhook signature is your way to verify that the messages are sent by Codat and helps you avoid impersonation or replay attacks. We sign every webhook and its metadata with a unique key for each endpoint and include timestamps for when the message attempt occurred.

You can use this signature to verify that the message truly came from Codat and process it. Our webhook service partner provides instructions, examples, and libraries in their [webhook verification documentation](https://docs.svix.com/receiving/verifying-payloads/how).
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should bring Svix's docs into ours and use these as the webhook builder section of the docs. That way we can use Codat specific event types in the example and outline best practices when consuming events.

@pzaichkina pzaichkina added the DO NOT MERGE WIP or a spike label Feb 26, 2024
dcoplowe
dcoplowe approved these changes Mar 4, 2024
View reviewed changes
docs/lending/features/sales-overview.md Outdated Show resolved Hide resolved
docs/lending/features/liabilities-overview.md Outdated Show resolved Hide resolved
docs/lending/features/financial-statements-overview.md Outdated Show resolved Hide resolved
docs/lending/features/bank-statements-overview.md Outdated Show resolved Hide resolved
docs/lending/features/accounts-receivable-overview.md Outdated Show resolved Hide resolved
docs/lending/features/accounts-payable-overview.md Outdated Show resolved Hide resolved
@dcoplowe
Copy link
Collaborator

dcoplowe commented Mar 4, 2024

Some minor changes needed.

@pzaichkina pzaichkina removed the DO NOT MERGE WIP or a spike label Mar 4, 2024
@pzaichkina pzaichkina merged commit 13e23e9 into main Mar 4, 2024
3 checks passed
@pzaichkina pzaichkina deleted the feat/webhooks branch March 4, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dcoplowe dcoplowe dcoplowe approved these changes

@mcclowes mcclowes Awaiting requested review from mcclowes mcclowes is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pzaichkina @dcoplowe