← API Index
/api/system/pushhook/list
Shows the push hook configuration (one entry; configured=false if no external push provider is set). Requires an API-role executor with the settings permission (UPDATE_SETTINGS_ACTION_ACCESS).
Parameters
| Name |
Description |
Type |
| oo-rf |
optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml |
String |
| oo-auth |
optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. |
int |
Error Responses
| HTTP Status |
Error Code |
Description |
| 401 |
not_authorized |
Caller is not an API-role executor, or lacks the settings permission (UPDATE_SETTINGS_ACTION_ACCESS) |
Response Types
| Type |
Version |
Description |
| PushHook |
1 |
The push hook configuration. When a URL is configured, push notifications (matching the type filter) are handed to that external provider instead of being sent by the platform itself |
OpenAPI
See list.yaml
Referenced in skills