Skip to main content
Version: 2.1.0

Publish a notifier request event

This section describes how to publish a new notification request event to Notifier with AMQP message.

To learn more about global description of REGARDS AMQP api see Regards AMQP API

Exchange​

Submission requests have to be published to this REGARDS RabbitMQ exchange:

ExchangeVirtual host
regards.broadcast.fr.cnes.regards.modules.notifier.dto.in.NotificationRequestEventregards.multitenant.manager

Request content​

Properties​

PropertyTypeDescription
metadataA free JSON elementMetadata about the product notification
payloadA free JSON elementThe product to broadcast

Headers​

HeaderTypeDescription
regards.tenantStringThe tenant
regards.request.idStringString of max 36 characters long
regards.request.dateStringISO 8601 date
regards.request.ownerStringString of max 128 characters long

Integration with Feature Manager and Ingest​

Creations, updates or deletions of features or AIPs are optionally sent to Notifier, this consist of the payload.

metadata is a field allowing Ingest or Feature Manager to send additional information to Notifier that rules and notification plugins might use or require.

Template of notified feature​

{
"metadata": "{whatEverIsNeededOrWanted}",
"payload": "{feature}"
}

Notification management​

How to retry notifications that failed​

To retry notifications that failed, you need to send a new AMQP event with the same regards.request.id header.

  • If your event does not contain anybody, it will retry the same event
  • If you provide a body, it will be taken into account before retrying.