...
| Page Properties | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
Resources & Remarks Modification History
|
| Excerpt |
|---|
Configuration of system hooks, split in AMQP hooks and webhooks. |
...
| Parameter Section | Parameter | Type | Description |
|---|---|---|---|
amqp | List of mappings in JSON format. | List of single AMQP Hook configurations each of them defined via following parameters. Read by API gateway and COMMANDER service. As of version 2021 Summer, placeholders can be used as provided by spring. They can reference values in the system environment including configuration files and command line arguments. The placeholders will be replaced by the referenced values of the environment variable during the starting process of the corresponding service. The syntax follows the spring placeholders: | |
bulkSize | integer | Maximum bulk size for a message. | |
enable | boolean | Specified Specifies whether this configuration is active/enabled (true) or inactive/disabled (false). | |
password | string | Password for the AMQP server. | |
predicate | string | Condition that specifies when the AMQP hook is used. supported scripting languages: SpEL (Spring Expression Language) and JavascriptJavaScript. All properties that are available in the corresponding hook's JSON request body can be referenced. Additionally, the tenant can always be referenced via options['tenant']. | |
queue | string | Name of the queue to which the messages are written. Only one messaging queue can be used. The messaging queue specified for the first defined AMQP hook will apply to all following AMQP hook definitions as well. The messaging system needs to support AMQP 1.0. | |
type | string | Defines the processing step during which the AMQP hook will be trigger. | |
url | string | AMQP server endpoint, e.g. 127.0.0.1:5672 | |
user | string | Username for the AMQP server. | |
webhooks | List of mappings in JSON format. | List of single Webhook configurations each of them defined via following parameters. Read by AUTHENTICATION service and API gateway. If multiple Webhooks are registered for the same Webhook type, the predicate is applied to the original predicate target for each of them and in the order of definition. | |
enable | boolean | Specifies whether this configuration is active/enabled (true) or inactive/disabled (false). | |
predicate | string | Condition that specifies when the webhook is used. | |
type | string | Defines the processing step during which the webhook will be trigger. | |
url | string | Endpoint to be called by the webhook if the predicate matches. | |
...
- GET /api/system/systemhooks - Retrieve the global
systemHookConfiguration.json. - POST /api/system/systemhooks - Update the global
systemHookConfiguration.json. - POST /api/system/systemhooks/validate - Validate the global
systemHookConfiguration.json. - GET /api/system/apps/{app}/systemhooks - Retrieve the app-specific
systemHookConfiguration.json. - POST /api/system/apps/{app}/systemhooks - Update the app-specific
systemHookConfiguration.json. - POST /api/system/tenants/{tenant}/apps/validate - Validate the app-specific
systemHookConfiguration.json.
...
To activate this configuration, both the API-gateway and the Authentication AUTHENTICATION service need to be restarted.
...