REST

This section details how to configure REST notifications.

How to create a REST notification

1. Log in to Horizon Administration Interface.

2. Access REST from the drawer or card: Notifications  REST.

3. Click on Add REST notification.

4. Fill in all mandatory fields in the Notifications details panel.

  • The Name of the notification.

  • The Lifecycle event triggering the notification.

    • First, select the entity Type can be one of:

      • CA: events on the Certification Authority lifecycle, like expiration of a CA

      • CRL: events on the CRL lifecycle, like a generation or update

      • OCSP Signer: events on the OCSP Signers lifecycle, like expiration of an OCSP signer

      • System: events concerning Stream global objects, like credentials or license expiration

      • Timestamping Signer: events on the Timestamping Signers lifecycle, like expiration of a Timestamping signer

    • Then, select the Event you wish to send the notification on.

  • Select the notifications to send On execution error of this Notification to be alerted if it failed.

  • The Delay before notification sending is only enabled when the Event is about the expiration of an entity. This is the period where the notification will be sent before the expiration date.

5. Fill in all mandatory fields in the Notifications Rest details panel.

  • The REST HTTP method and URL that the HTTP request will use

  • The Proxy used by Stream to send the HTTP request.

  • The Timeout to wait before stopping listening to an answer.

  • The Accepted response HTTP code(s) to consider the request in success state.

  • The Authentication type and credentials used by the HTTP request, for example, the basic authentication.

  • The Headers sent along with the HTTP request. Each header value is a template string that will be dynamically evaluated when sending the notification.

  • The Payload of the HTTP request. It is a template string that will be dynamically evaluated when sending the notification.

You can click on the expand button next to the "Dynamic attributes" section, in order to get a range of possibilities on which dictionaries and functions are available.

6. Click on the save button.

You can edit Edit Emails, duplicate Duplicate Emails or delete Delete Emails the Email Notification.