starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-03-21 17:10:10 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Closes #21284: Add deprecation note to webhooks documentation (#21491)

Browse Source 
* Add searchable deprecation comments on request_id and username fields in EventContext

* Add deprecation note in webhooks documentation

* Expand deprecation note/warning

* Add version number to deprecation warning

* Add deprecation warning to two other places
This commit is contained in:
bctiemann
2026-02-20 13:52:42 -05:00
committed by GitHub
parent d5e8f7dafa
commit 3320e07b70
3 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/integrations/webhooks.md
View File

@@ -31,6 +31,11 @@ The following data is available as context for Jinja2 templates:
* `data` - A detailed representation of the object in its current state. This is typically equivalent to the model's representation in NetBox's REST API.
* `snapshots` - Minimal "snapshots" of the object state both before and after the change was made; provided as a dictionary with keys named `prechange` and `postchange`. These are not as extensive as the fully serialized representation, but contain enough information to convey what has changed.
!!! warning "Deprecation of legacy fields"
The "request_id" and "username" fields in the webhook payload above are deprecated and should no longer be used. Support for them will be removed in NetBox v4.7.0.
Use `request.user.username` and `request.request_id` from the `request` object included in the callback context instead.
### Default Request Body
If no body template is specified, the request body will be populated with a JSON object containing the context data. For example, a newly created site might appear as follows: