Versions Compared

Old Version 1

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version 2

changes.mady.by.user Technische Redaktion

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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


Excerpt
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. Only the structure of the request body is validated, but not the concrete values for the individual parameters like, e.g., predicate or url. 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 and in all Apps that are enabled for the corresponding tenant.

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

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

/api/system/systemhooks

Code Block
languageyml
{
    "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

...