POST /api/system/systemhooks

Owned by Technische Redaktion
Last updated: Apr 29, 2022
2 min read
As of Versionproduct version 2022 Summer
Request MethodPOST
Response FormatHTTP status code
Required Permission

available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched.

>> AUTHENTICATION Service
Description

Updates the global system hook configuration.

The content of the global systemHookConfiguration.json configuration file is replaced by the configuration specified in the JSON request body. Its structure is validated and has to match the structure described here. Especially, the type of each defined AMQP hook and webhook has to be valid.

The configured system hooks are available in all tenants.

The changes are applied immediately after a successful update of the configuration.

Request HeadersContent-Type: [application/json]
Request Example

/api/system/systemhooks

{
    "systemhooks": {
        "amqp": [
            {
                "bulkSize": 10,
                "enable": true,
                "password": "secret",
                "predicate": "spel:(contentStreams != null && contentStreams.size() > 0 && contentStreams[0]['range'] != null && contentStreams[0]['range'].length() > 0) ? true : false",
                "queue": "lc.textextraction",
                "type": "object.insert.document",
                "url": "10.10.6.243:5674",
                "user": "clouduser"
            }
        ],
        "webhooks": [
            {
                "enable": true,
                "predicate": "spel:true",
                "type": "user.info",
                "url": "http://organization/api/userinfo/${tenant}/${userId}"
            }
        ]
    }
}
Response Example

200 OK