try out ↗

← API Index


/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).

Parameters

Name Description Type
url absolute http(s) URL that receives one JSON POST per push notification (required) string
types comma-separated push type names to delegate (optional, empty = all types); possible values see PushHook.types string
errorMail comma-separated email address(es) notified on delivery failure string
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)
400 parameter_error Parameter validation failed (url missing or not absolute http(s), unknown push type, invalid mail; detail in error_field:error_reason)

Response Types

Type Version Description
PushHookResult 1 Result of a push hook create/drop operation

OpenAPI

See create.yaml

Referenced in skills