Improved Webhooks Documentation for Greenlight #580
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
ssganesh035
commented
Mar 3, 2025
ssganesh035
commented
- Enhanced clarity and structure for better readability.
- Expanded explanations for event subscriptions, verification, and security best practices.
- Provided step-by-step instructions for adding, managing, and rotating webhooks.
- Ensured consistent formatting and correct Markdown syntax for seamless GitHub integration.
ssganesh035
changed the title
Randy808
reviewed
Mar 4, 2025
docs/src/reference/webhooks.md
Outdated
| secret_response = scheduler.rotate_outgoing_webhook_secret(1) | ||
| ``` | ||
|
|
||
| ## Testing Webhooks |
Collaborator
There was a problem hiding this comment.
Please remove this. We don't want to refer to any specific services for testing.
Contributor
Author
There was a problem hiding this comment.
Hi @Randy808, hope you are doing well. My intention was to help fellow developers with comprehensive documentation, if you want I can add a caution note for using external tools.
Collaborator
There was a problem hiding this comment.
I would like it removed. It could be misconstrued as an endorsement of these 2 sites and it's inclusion in this PR looks like marketing.
Contributor
Author
There was a problem hiding this comment.
Understood, I've removed it. Hope it's good to go now @Randy808
Randy808
approved these changes
Mar 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.