System Hooks, that allow for messaging triggered by function calls under specified conditions.

Table of Contents

Introduction

With an AMQP Hook, messages are sent to a configured messaging system using Advanced Message Queuing Protocol 1.0 (AMPQ). Where and when these messages are sent is defined in the System Hook configuration. Any changes to the System Hook configuration will not apply until the affected services have been restarted.

The AMQP Hooks allow for asynchronous reactions to events like object creation, update or deletion. There are different types of AMQP Hooks available, each of them specialized for selected function calls. The messages contain the object metadata which is the target of the function call triggering the AMQP Hook. The action code is included in the message as well as the history code that is added to the audit trail. The AMQP Hook can be triggered by any endpoint that induced the characteristic history codes of the AMQP Hook.

Types of AMQP Hooks

AMQP Hook Type	Description	Action / History Codes
dms.response.delete	Object deletion events can trigger this AMQP Hook with the corresponding object properties in its body.	200 - OBJECT_DELETED 202 - OBJECT_FLAGGED_FOR_DELETE
dms.response.insert	Object creation events can trigger this AMQP Hook with the corresponding object properties in its body.	101 - OBJECT_CREATED_WITH_CONTENT 100 - OBJECT_CREATED
dms.response.update	Object update events and tag operations can trigger this AMQP Hook with the corresponding object properties in its body.	300 - OBJECT_METADATA_CHANGED 301 - OBJECT_DOCUMENT_CHANGED 325 - OBJECT_RESTORED_FROM_VERSION (as of 2022 Spring) 303 - OBJECT_UPDATE_CONTENT_MOVED 110 - OBJECT_TAG_CREATED 310 - OBJECT_TAG_UPDATED 210 - OBJECT_TAG_DELETED

Configuring AMQP Hooks

As a type of system hooks, AMQP Hooks are configured in the \service-manager\config\system\systemHookConfiguration.json configuration file within the service manager in JSON format. Any changes to the system hook configuration will not apply until the affected services have been restarted.

>> systemHookConfiguration.json

Summary

In this article, we gave an introduction to AMQP Hooks, covered the configuration using the example of asynchronous full text indexing and provide a list of all AMQP Hooks available. Check out Webhooks which are the second type of System Hooks in yuuvis® Momentum.

Read on

System Hooks

Define additional actions triggered by specified events, extend the functionality of yuuvis® Momentum API. Keep reading

Webhooks

A system hook that extends a function call by an HTTP call under defined conditions. Keep reading

Browser not supported