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.

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

Minor changes to webhooks docs #1052

Merged
merged 3 commits into from
Mar 7, 2024
Merged

Minor changes to webhooks docs #1052

merged 3 commits into from
Mar 7, 2024

Conversation

dcoplowe
Copy link
Collaborator

@dcoplowe dcoplowe commented Mar 6, 2024

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.

Copy link

vercel bot commented Mar 6, 2024

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

Name Status Preview Comments Updated (UTC)
codat-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 7, 2024 10:25am

Copy link

github-actions bot commented Mar 6, 2024

Overall readability score: 63.25 (🟢 +0)

File Readability
create-consumer.md 100 (🟢 +0)
event-types.md 64.13 (🟢 +0)
overview.md 100 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
create-consumer.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
event-types.md 64.13 64.71 8.67 7.7 8.4 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
overview.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 63.25 53.78 9.74 10.78 11.34 7.46
  🟢 +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


To start listening to messages we send you, configure your webhook consumer endpoints. Navigate to **Settings > Webhooks > Events > Configure consumer** and click **Add endpoint** to create a new consumer.
## Configure webhook consumer
Copy link
Contributor

Choose a reason for hiding this comment

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

Still sounds like your configuring the consumer itself rather than codat

Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe "Configure consumer in Codat"?

Copy link
Collaborator

Choose a reason for hiding this comment

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

or "Configure Codat to send events"

Copy link
Collaborator

Choose a reason for hiding this comment

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

or "Set up consumers in Codat"

or just "Add webhook consumers to Codat"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
## Configure webhook consumer
## Register webhook consumer with Codat

@dcoplowe dcoplowe enabled auto-merge March 7, 2024 10:19
Co-authored-by: Polina <[email protected]>
Co-authored-by: Max Clayton Clowes <[email protected]>
@dcoplowe dcoplowe merged commit a73af53 into main Mar 7, 2024
3 checks passed
@dcoplowe dcoplowe deleted the fixes/webhooks branch March 7, 2024 12:41
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.

3 participants