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

Add example to generic incoming webhook #8563

Open
ericholscher opened this issue Oct 5, 2021 · 4 comments
Open

Add example to generic incoming webhook #8563

ericholscher opened this issue Oct 5, 2021 · 4 comments
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required

Comments

@ericholscher
Copy link
Member

ericholscher commented Oct 5, 2021

Feedback from a user:

Feature request for your docs would be to just display an actual command (including the FULL url) you can use directly with tools like curl or node/python if you create a 'generic' webhook. Or even better, just include a hint at the right path to follow for other 'generic' webhook users with any sort of working example.

I'd love to see more of these "actionable" examples in our docs. Could also play with doing small 15 second videos as well showing the setup process.

/cc @readthedocs/advocacy

@stsewd
Copy link
Member

stsewd commented Oct 5, 2021

Just a note: this is related to our generic integration's incoming webhooks, not our webhook notifications feature.

@astrojuanlu
Copy link
Contributor

15 second videos can also be GIFs 😄 And another alternative, depending on the use case, is https://asciinema.org/

@astrojuanlu astrojuanlu changed the title Add example to generic webhook Add example to generic incoming webhook Oct 6, 2021
@astrojuanlu
Copy link
Contributor

In line with #8573, should we call these "incoming webhooks" just "integrations"? (We can continue the conversation there)

@stale
Copy link

stale bot commented Mar 2, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Mar 2, 2022
@stale stale bot closed this as completed Apr 16, 2022
@stsewd stsewd added Needed: documentation Documentation is required and removed Status: stale Issue will be considered inactive soon labels Apr 18, 2022
@stsewd stsewd reopened this Apr 18, 2022
@ericholscher ericholscher added the Accepted Accepted issue on our roadmap label Apr 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

3 participants