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

Add deprecation note in webhooks documentation

Browse Source
This commit is contained in:
Brian Tiemann
2026-02-19 10:02:25 -05:00
parent 7f1f976d07
commit 4264895302
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/plugins/development/webhooks.md
View File

@@ -43,6 +43,9 @@ The resulting webhook payload will look like the following:
}
```
!!! note "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 a future release.
!!! note "Consider namespacing webhook data"
The data returned from all webhook callbacks will be compiled into a single `context` dictionary. Any existing keys within this dictionary will be overwritten by subsequent callbacks which include those keys. To avoid collisions with webhook data provided by other plugins, consider namespacing your plugin's data within a nested dictionary as such: