question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Clarify webhook and integration documentation

See original GitHub issue

Coming 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 by Integrations 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”:

image

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.

cc @readthedocs/advocacy @readthedocs/backend

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

1reaction
ericholschercommented, Oct 11, 2021

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.

0reactions
astrojuanlucommented, Oct 13, 2021

I get what you say, but the advantages of renaming it to “integrations” are:

  • It is forward compatible with non-webhook integrations. We may or may not have this in the short term, but doesn’t harm getting used to it I think.
  • We avoid confusion with outgoing webhooks
  • We are consistent with the UI menus (there’s an “integrations” link and header in the settings)
  • We are consistent with other products
Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found