Notifications - Page

In the Notifications page, Coveo Cloud organization members can configure notifications to be informed when certain events (activities) occur in their organization. For instance, you could choose to receive an email when a source fails to rebuild. These periodical customized reports allow you to watch closely certain events, errors, or changes in your organization.

When you have the required privileges, you can review and delete the default subscriptions and those created by your organization members (see User Notifications). You can also subscribe to custom notifications (see Add/Edit an Organization Notification).

The organization notifications you set up in the Notifications page are similar to the user notifications one can configure, but offer additional options (see User Notifications). As an administrator, in the Notifications page, you can configure notifications to be sent via a webhook or JSON email, rather than in a classic email. Moreover, this page displays all organization and user notifications created by your organization users.

Unlike user notifications, organization subscriptions are not deleted when their author is deleted from the organization. They remain active and keep sending reports to the specified webhook or email address. Hence, users wanting to receive notifications for their own use should create a user notification. Temporary users and administrators wanting to receive the notifications as JSON content or as a post to an endpoint should create an organization notification.

  • By default, the organization contact is notified when a member of their Coveo Cloud organization hits a license limit (see Review the Organization Limits of Your Organization License).

    The organization contact receives an email when an organization member opens a dashboard that contains a number of cards exceeding your organization license agreements.

  • The default subscription can have been deleted. You can recreate the subscription by adding a user notification with the following configuration (see Add/Edit a User Notification). This configuration alerts you whenever an organization limit is hit (see Review the Organization Limits of Your Organization License).

    Parameter Value
    Notification frequency Instantly
    Results All
    Resource types Licenses
    Operations Limit hit

Access the “Notifications” Page

  1. If not already done, log in to your Coveo Cloud organizationwith a user that is a member of a group with the required privileges (see Required Privileges).

  2. In the main menu on the left, under Organization, select Notifications.

Filter Organization Notifications

In the Notifications page, in the right section of the Action bar, type keywords in the Filter box (see Access the Notifications Page). You can filter notifications by name, frequency, and date or time of last modification.

To clear the filter and display notifications again, in the Filter box, click the X icon.

Add/Edit an Organization Notification

To add a notification, in the Notifications page, in the top-right corner, click Add Notification (see Access the Notifications Page and Add/Edit an Organization Notification - Panel).

To edit a notification, in the Notifications page, select the notification to edit, and then, in the Action bar, click Edit (see Access the Notifications Page and Add/Edit a User Notification).

Disable/Enable an Organization Notification

When you want Coveo Cloud V2 to stop sending email notifications without deleting the corresponding notification configuration, you can disable it (see Access the Notifications Page). To start receiving these notifications again, you can enable them again.

In the Notifications page, select the notification to disable/enable, and then, in the Action bar, click More > Disable/Enable.

Test an Organization Notification

You can test a notification to ensure that you receive the expected information. For instance, you may want to check that your webhook receives your notifications, or that email notifications are not sent to your spam folder.

In the Notifications page, select the notification to test, and then, in the Action bar, click More > Test (see Access the Notifications Page).

Delete an Organization Notification

In the Notifications page, select the notification to delete, and then, in the Action bar, click More > Delete (see Access the Notifications Page).

Review the Usage Statistics of an Organization Notification

You can review the number of successes, failures, errors, and cancellations related to a notification for troubleshooting purposes.

To review the usage statistics of an organization notification, in the Notification page, select the desired notification, and then, in the Action bar, click Usage Statistics (see Access the Notifications Page).

The Usage Statistics panel displays the following information:

  • Number of successes: Number of times today that the notification was successfully processed and sent to the expected email addresses or service URLs.

  • Number of failures: Number of times today that the email or webhook server to which the notification was sent returned an error or could not be reached.

  • Number of errors: Number of times today that an unexpected error occurred while Coveo Cloud V2 was processing the notification.

  • Number of cancellations: Number of times today that the activity related to the notification occurred but did not cause a notification to be sent (e.g., the daily notification limit was reached (see Review the Organization Limits of Your Organization License)).

Review the Activity Regarding Extensions

In the Extensions page, in the right section of the page header, click the Activity icon (ac8-icon-clock) (see Access the Notifications Page and Activity - Panel).

If the Activity icon is grayed and unresponsive, you do not have all the privileges required to perform this action (see Required Privileges).

Reference

The information you can review on the Notifications page table is:

  • Name column

    The name of the notification.

  • Description column

    The description of the notification.

  • Type column

    The format in which you chose to receive the notifications. Available options are Email, Email JSON, and Webhook (see .

  • Author column

    The identity that created the notification.

    The default subscription author is automated-tests@coveo.com-google.

  • Frequency column

    The frequency at which the author will receive the notifications.

  • Status column

    The indicator shown is based on the notification error rate, i.e., the number of notifications that could not be sent divided by the total number of notification attempts since the notification was configured. Coveo Cloud V2 considers that a notification cannot be sent when the email bounces back or when a webhook is down, for instance. The indicator is updated every five minutes.

    The error rate may be reset if no notification has been sent in a long time. The status then returns to Unknown.

    Use this indicator to identify notifications that encounter frequent issues.

    The possible values are:

    • Unknown - Grey indicator

      No notification has been sent yet.

    • Good - Green indicator

      Less than 5% of the notifications could not be sent successfully.

    • Warning - Yellow indicator

      Between 5 and 20% of the notifications could not be sent successfully. There may have been occasional issues, or your email or webhook server may have recently been unreachable.

    • Problematic - Red indicator

      More than 20% of the notifications could not be sent successfully. There may have been regular issues, or your email or webhook server may have recently been unreachable.

    A webhook notification is successfully sent on the first nine attempts following its creation. The error rate is therefore 0%, i.e., 0 notifications that could not be sent out of 9 delivery attempts. The notification status is Good.

    On the tenth attempt, your server is down, and the delivery process fails. The error date is then 10%, i.e., 1 failure out of 10 attempts. The notification status is Warning.

    Your server is back up and the notification delivery process is successful again. On the 21st attempt, the notification error rate falls is under 5% (1 failure out of 21 attempts), and the notification status changes back to Good.

  • Last Modified column

    The date and time of the last notification modification.

Required Privileges

The following table indicates the privileges required to view or edit elements of the Notifications page and associated panels (see Privileges).

Action Service - Privilege Required access level
View notifications

Organization - Notifications

Organization - Organization

 View
Edit notifications

Organization - Organization

 View

Organization - Notifications

 Edit