Save notifications

In some use cases it may be useful to inform third party services after a collection has been saved - e.g. to propagate metadata changes to another backend system.

Fusion allows configuring a REST endpoint that will be notified after saving changes.

Message format

Changes are propagated by a REST POST request containing information about the changes that have just been made.

The message format is as follows:

{
  "oldCollection" : { ... },    // old collection as json
  "newCollection" : { ... }     // new collection as json
}

Configuration

In addition to the endpoint URL, a whitelist of collection types can be specified in the configuration in order to support save notifications only for a subset of collection types. If the whitelist is empty, notification takes place for all collection types.

The feedback request can be secured using user authentication, basic authentication or a static bearer token.

The authentication is optional and can be configured via Helm values:

organizer:   
  saveNotification:
    enabled: false
    url:
    typeIdsWhitelist: ['generic']
    auth:
      userAuth:
        enabled:
      basicAuthenticated:
        enabled: 
        username:
        password:
      bearerAuthenticated:
        enabled: 
        bearerToken:

User authentication

organizer.saveNotification.auth.userAuth.enabled - "true" to enable

Basic authentication

organizer.saveNotification.auth.basicAuthenticated.enabled - "true" to enable organizer.saveNotification.auth.basicAuthenticated.username - authenticated technical user organizer.saveNotification.auth.basicAuthenticated.password - corresponding password

Bearer authentication

organizer.saveNotification.auth.bearerAuthenticated.enabled - "true" to enable organizer.saveNotification.auth.bearerAuthenticated.bearerToken - static bearer token

Choose one of the authentication types by setting the enabled flag to "true" or omit all to disable authentication.