try out ↗

← API Index


/api/system/webhook/list

Lists all 4 webhook slots and their configuration. 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
Webhook 1 One of the 4 webhook slots and its configuration

OpenAPI

See list.yaml