Manage User Notifications

Coveo Administration Console users can configure email notifications to be informed when certain operations occur in their organization. For example, you could subscribe to receive an alert when a source is in error, when a change is applied to your Coveo Cloud license, etc. These periodical customized reports should allow you to watch closely certain events, errors, or changes in your organization.

User notifications are deleted when their author is deleted from the organization. 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 (see Manage Organization Notifications).

Add or Edit a User Notification

The Add/Edit a User Notification panel lets you configure a new user notification or modify an existing one. To add an organization notification, see Manage Organization Notifications.

  1. in the User Notifications panel, click Add Notification in the upper-right corner or click the notification to edit, and then in the Action bar, click Edit.

  2. In the Name box, enter a name for your user notification. This name is displayed in the Notifications panel (see Manage User Notifications).

  3. Optionally, in the Description box, enter a description for your notification.

  4. In the Notification frequency drop-down menu, select the frequency at which you want to receive email notifications:

    • Live: You receive an email notification immediately and can receive many a day.

    • Hourly: You receive an email notification every hour, on the hour.

    • Daily: You receive an email notification every day at 8:00 PM.

    • Weekly: You receive an email notification every week on Saturday at 8:00 PM.

  5. In the Email content section, specify the operations of which you want to be notified:

    1. The resource types in which you’re interested must appear under Resource types. By default, All is selected, so that you’re notified of operations on all resource types. If you want to be notified of operations affecting only some specific types of resource, delete All and specify the desired resource types.

    2. The operations of which you want to be notified when they apply to the selected resource types must appear under Operations. By default, All is selected, so that you’re notified of all operations. If you want to be notified of some specific operations only, delete All and specify the desired operations.

    3. Under Results, select the operation results of which you want to be notified. Select Failed to receive only notifications for failed operations, or select All to be notified of all operations.

  6. Click Add Notification or Save.

Coveo Administration Console users can only configure notifications to be sent to themselves. If you wish for another member of your organization to receive the same notifications, they’ll need their own Administation Console user account with the required privileges and will need to follow the same steps.

Example 1

You want to be notified immediately every time a source update fails (see Refresh VS Rescan VS Rebuild). You configure a notification as follows:

Name: Source Update Fails

Description: Refresh, Rebuild, or Rescan fails

Notification frequency: Live

Results: Failed

Resource types: Sources

Operations: Refresh (source), Rescan, and Rebuild

Example 2

You want to receive a daily report of changes occurring on the API Keys page (see Manage API Keys). You configure a notification as follows:

Name: API Key Changes

Description: Any change in the API Keys page

Notification frequency: Daily

Results: All

Resource types: API keys

Operations: Activation, Addition, Configuration edit, Deactivation, and Deletion

Disable or Enable a User Notification

When you want to stop receiving email notifications without deleting the corresponding notification configuration, you can disable it. To start receiving these notifications again, you can enable them.

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

Delete a User Notification

In the User Notifications panel, click the notification to delete, and then in the Action bar, click More, and then select Delete.

Reference

The information you can review in the User Notifications panel table is:

  • Name column

    The name of the notification.

  • Frequency column

    The frequency at which you receive the notifications.

  • Status column

    The notification status (see Status column).

  • 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 User Notifications panel and associated panels (see Manage Privileges and Privilege Reference).

Action Service - Domain Required access level
View and edit user notifications

Organization - Activities

View

A member with the privilege to view activities (i.e., the View access level on the Activities domain) can see activities from Administration Console pages they don’t have the required privileges to access (see Manage Privileges and Activities Domain).

Recommended Articles