Add note about namespacing webhook data

This commit is contained in:
Jeremy Stretch 2025-08-07 16:28:01 -04:00
parent fb9f053257
commit c9067ec4bb

View File

@ -43,6 +43,18 @@ The resulting webhook payload will look like the following:
} }
``` ```
!!! 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:
```python
return {
'my_plugin': {
'foo': 123,
'bar': 456,
}
}
```
### Callback Function Arguments ### Callback Function Arguments
| Name | Type | Description | | Name | Type | Description |