Export notifications

In some use cases it may be useful to inform third party services after a document has been exported - e.g. to trigger further processing in an external system or log the export event.

Fusion allows configuring a REST endpoint that will be notified after exporting documents.

Message format

Export events are propagated by a REST POST request containing information about the export that was just completed.

The message format is as follows:

{
    "app": "dossier-organizer",
    "status": "success" | "error",
    "collectionId": <collectionId>,
    "timeStamp": <exportTime>,
    "collectionMetadata": { ... },
    "output": [
      <exportUrl>
    ]
}

Configuration

The export notification endpoint URL is configured in addition to optional authentication settings.

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

Configure via Helm values:

organizer:
  exportNotification:
    enabled: false
    url:
    auth:
      userAuth:
        enabled: false
      basicAuthenticated:
        enabled: false
      bearerAuthenticated:
        enabled: false

secrets:
  exportNotification:
    username:
    password:
    bearerToken:

Authentication Methods

User Authentication: organizer.exportNotification.auth.userAuth.enabled: true

Basic Authentication: Set organizer.exportNotification.auth.basicAuthenticated.enabled: true and provide credentials in secrets.exportNotification.username and secrets.exportNotification.password

Bearer Token: Set organizer.exportNotification.auth.bearerAuthenticated.enabled: true and provide token in secrets.exportNotification.bearerToken

Choose one of these methods or omit all to disable authentication.

For detailed information about sealed secrets, please refer to the Sealed Secrets documentation.