try out ↗

← API Index · ↑ parent


/api/system/pushhook

Methods

Endpoint Description
/api/system/pushhook/create Create (or replace) the push hook: once a URL is set, push notifications matching the type filter are handed to that external provider instead of being sent by the platform. Requires an API-role executor with the settings permission (UPDATE_SETTINGS_ACTION_ACCESS).
/api/system/pushhook/drop Drop (clear) the push hook so push notifications are sent by the platform again. Requires an API-role executor with the settings permission (UPDATE_SETTINGS_ACTION_ACCESS).
/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).