try out ↗

← API Index


/api/system/webhook/create

Create (or replace) a webhook in an explicitly named slot (0-3). Requires an API-role executor with the settings permission (UPDATE_SETTINGS_ACTION_ACCESS).

Parameters

Name Description Type
id webhook slot id to create/replace (0-3, see /api/system/webhook/list) int
url target URL to call on matching events (required) string
events comma-separated action codes to trigger on (required, see /api/system/eventtypes; also see NEOS/NEOS1 in setup_webhooks.md) 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 (id missing/out of range, url/events missing, or a value doesn't validate; detail in error_field:error_reason)

Response Types

Type Version Description
WebhookResult 1 Result of a webhook create/drop operation

OpenAPI

See create.yaml