Enhance Webhooks Documentation with Examples and Testing Tools #156
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
ssganesh035
commented
Mar 18, 2025
ssganesh035
commented
- Improved clarity and structure of the Webhooks documentation.
- Expanded explanations for configuring event rules and webhooks in NetBox.
- Added a detailed example of a webhook payload.
- Provided guidance on handling email notifications via external services.
amyasnikov
reviewed
Mar 19, 2025
docs/features/webhooks.md
Outdated
| "custom_fields": {}, | ||
| "created": "2023-04-12T19:36:33.690567Z", | ||
| "last_updated": "2023-04-12T19:36:33.690588Z" | ||
| "created": "2023-04-12T19:36:33.690567Z" |
Owner
There was a problem hiding this comment.
All these deleted fields fields must stay as is, they're present in the webhook body
| ## Creating a Webhook and Event Rule | ||
|
|
||
| You may do the same thing using web GUI (`Other > Webhooks` menu) | ||
| You can create a webhook and an event rule programmatically using the [pynetbox](https://github.com/netbox-community/pynetbox) library or via the NetBox web UI (`Other > Webhooks` menu). |
Owner
There was a problem hiding this comment.
Other > Webhooks is outdated. Kindly provide right GUI section.
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.