Notifications

This section explains how to configure notifications in Horizon. Horizon currently supports 2 types of notifications : mail notifications and instant messaging notifications.

Email Notifications

This section details how to configure the email notifications.

How to create a mail notification

1. Log in to Horizon Administration Interface.

2. Access emails from the drawer or card: Notifications > Emails.

3. Click on Add Mails.

4. Fill in all mandatory fields.

  • Name* (string input):
    Enter a meaningful mail notification name.

  • Event type* (select):
    Select the event type to notify (certificate or request).

  • Event* (select):
    Select the event to notify.

  • Retries in case of error (int):
    Select the number of times Horizon should retry to send the notification in case of error. The default value is set to 10.

  • From*: (string input)
    Enter the email address that will appear in the email "From" field.

  • To*: (select multiple & input multiple)
    Select one or several recipients. You may also enter an email address.

  • Subject* (string input):
    Enter the email subject. You may use dynamic attributes, that will be automatically replaced by the appropriate values upon email generation.

  • Body* (string input):
    Enter the email body. You may use dynamic attributes, that will be automatically replaced by the appropriate values upon email generation.

  • Is HTML (boolean):
    Sets whether the email body contains HTML code (true) or plain text (false). The default value is set to false.

You can click on the "+" next to "How to use dynamic attributes" in order to get a range of possibilities from which one or more may be chosen.

In case you selected any Certificate type event any Request type event but the Enroll requests ones:

  • Attachments (list):
    Sets whether to attach the certificate to the email notification and which format to use for the attached certificate (if any).

    • Attach certificate (PEM) attaches the certificate under PEM format

    • Attach bundle (PEM) attaches the certificate as well as the entire trust chain used to sign it in PEM format

    • Attach certificate (PKCS#7) attaches the certificate under PKCS#7 format

    • Attach bundle (PKCS#7) attaches the certificate as well as the entire trust chain used to sign it in PKCS#7 format

    • Attach certificate (DER) attaches the certificate under DER format

In case you selected *Certificate Expiration*:

  • Duration before certificate expiration causing the notification* (finite duration):
    Sets how long before certificate expiration the email notification should be sent. The default value is set to 5 days.

  • Run on renewed (boolean):+ Sets whether the expiration notification should be sent even though the certificate has been renewed. Default value is set to false (if the certificate has been renewed, the notification will not be sent).

In case you selected as an Event Enroll request Approval or Recover request Approval:

  • Attach PKCS#12 (set at false) (boolean):
    Sets whether the certificate in PKCS#12 format (certificate + private key encrypted by password) should be attached to the email. The default value is set to false.

  • Send email if (select unique):
    Select either Always - Centralized (Horizon generates the private key) - Decentralized (a CSR is provided to Horizon). The default value is set to Always.

In case you selected as an Event Enroll request Pending or Revoke request Pending or Recover request Pending or Update request Pending or Migrate Request Pending:

  • Duration after request submission causing the notification* (finite duration):
    Duration after request submission causing the notification to be sent, in case the request was not approved in the meantime. The default value is set to 5 days.

6. Click on the save button.

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

Messaging

This section details how to configure the messaging notifications.

Prerequisites

You will need a webhook URL from the messaging tools in order to send notification.

How to create a Messaging notification

1. Log in to Horizon Administration Interface.

2. Access Messaging from the drawer or card: Notifications > Messaging.

3. Click on Add notification.

4. Fill in all mandatory fields.

  • Name* (string input):
    Enter a meaningful email notification name.

  • Event type* (select):
    Select the event type to notify (certificate or request).

  • Event* (select):
    Select the event to notify.

  • Retries in case of error (int):
    Select the number of times Horizon should retry to send the notification in case of error.The default value is set to 10.

  • Timeout* (finite duration):
    The time before Horizon stop trying to connect to Webhook or Proxy.

  • Proxy (option):
    The HTTP/HTTPS proxy to use to reach the messaging tool, if any.

  • To* (select):
    Select one of:

  • Title* (string input):
    Enter the title of the instant messaging. You may use dynamic attributes, that will be automatically replaced by the appropriate values upon notification generation.

  • Body* (string input):
    Enter the body of the instant messaging. You may use dynamic attributes, that will be automatically replaced by the appropriate values upon notification generation.

You can click on the "+" next to "How to use dynamic attributes" in order to get a range of possibilities from which one or more may be chosen.

In case you selected as an Event Certificate Expiration:

  • Duration before certificate expiration causing the notification* (finite duration):
    Sets how long before certificate expiration the messaging notification should be sent. The default value is set to 5 days.

In case you selected as an Event Enroll request Pending or Revoke request Pending or Recover request Pending or Update request Pending or Migrate request Pending:

  • Duration after request submission causing the notification* (finite duration):
    Duration after request submission causing the messaging notification to be sent, in case the request was not approved in the meantime. The default value is set to 5 days.

6. Click on the save button.

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