Clarify webhook and integration documentation
See original GitHub issueComing from #8522:
So, in our docs we have a
webhooks
page…
Seeking some feedback on the terminology here. We could:
- Rename
/webhooks.html
to/integrations.html
- Replace
Incoming Webhooks and Automation
byIntegrations and Automation
, - And use the term “integration” rather than “webhook” throughout the page, unless it refers to a UI option.
This would be more consistent with the UI. However, each of these individual integrations is still called “incoming webhook”:
Therefore, for full consistency, probably we should rename “incoming webhook” to just “integration”. I just checked that this is what GitHub and MailerLite do.
What do folks think?
And then, after renaming /webhooks.html
, would it be wise to repurpose the URL for outgoing webhooks? Otherwise, we would keep them at https://docs.readthedocs.io/en/stable/build-notifications.html#using-webhook, including the upcoming new features introduced at https://github.com/readthedocs/readthedocs.org/pull/8522.
Issue Analytics
- State:
- Created 2 years ago
- Comments:6 (6 by maintainers)
Top Results From Across the Web
Webhooks - GitLab Docs
Integrate with Twilio to be notified via SMS every time an issue is created for a specific project or group in GitLab. Automatically...
Read more >What is a webhook? - Red Hat
A webhook is an HTTP-based callback function that allows lightweight, event-driven communication between 2 application programming ...
Read more >Webhooks Explained: What They Are & How to Use Them
So let's take time today to explain what webhooks are and how leveraging them will step up your dev game. What you'll find...
Read more >Guide for Webhooks - Pipedrive Developer Documentation
Learn about what are Webhooks and how they can be used in Pipedrive as well as help you in developing an app.
Read more >What are webhooks: How they work and how to set them up
What is a webhook? ... Webhooks are one of a few ways web applications can communicate with each other. It allows you to...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Agreed here. I tried to figure out our GH webhook docs the other day and they’re super confusing. Definitely lots of room for improvement here, outside of renaming.
I get what you say, but the advantages of renaming it to “integrations” are: