GET /api/system/apps/{app}/systemhooks

Owned by Technische Redaktion
Last updated: Apr 28, 2022 by Team OktopusVersion comment
1 min read
As of Versionproduct version 2022 Summer
Request MethodGET
Response FormatJSON
Required Permission

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

>> AUTHENTICATION Service
Description

Retrieves the app-specific system hook configuration for the app specified in the request URL.

The content of the app-specific systemHookConfiguration.json configuration file is returned. The configured System Hooks are available only for the concrete App.
Note: The app-specific system hooks are available only in tenants where the corresponding app is enabled.

An error with status code 404 is thrown if the specified app does not exist or no system hooks are configured for the specified app.

Request HeadersAccept: [application/json]
Request Example/api/system/apps/myapp/systemhooks
Response Example
{
    "systemhooks": {
        "amqp": [],
        "webhooks": [
            {
                "enable": true,
                "predicate": "spel:T(java.util.List).of(300).contains(options['action'])",
                "type": "dms.request.objects.upsert.storage-before",
                "url": "http://examplewebhook/api/dms/request/objects/update/metadata",
                "useDiscovery": true
            }
        ]
    }
}