Add/Edit an Organization Notification - Panel

The Add/Edit a Notification panel allows you to configure a new organization notification or modify an existing one to be informed when certain events (activities) occur in your organization (see Notifications - Page). 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.

  1. If not already in the Add/Edit a Notification panel, go to the panel (see Add/Edit an Organization Notification).

  2. In the Name box, enter a name for your user notification. This name is displayed in the Notifications page (see Notifications - Page).

  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:

    • Instantly: You receive an email notification immediately and can receive multiple 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 JSON filter section, edit the JSON to specify of what you want to be notified (see Organization Notification JSON Filter Reference).

  6. Under Notification type, select how you want to receive your notifications. Available options are:

    • Email

      In the To field, your email address is displayed. Optionally, in the Sender display name box, enter how you want the email sender name to appear. This allows you to easily identify the Coveo Cloud V2 organization notifications in your inbox.

    • Email JSON

      Select this option to receive the notification email in JSON format. In the To field, your email address is displayed. In the Sender display name box, enter how you want the email sender name to appear. This allows you to easily identify the Coveo Cloud V2 organization notifications in your inbox.

    • Webhook

      A webhook posts notifications to the endpoint you provide in the Service URL box.

  • You want to be notified immediately every time a source update fails (see Refresh VS Rescan VS Rebuild), and you want to receive the notifications as emails with JSON content. You configure a notification as follows:

    Name: Source Update Failures

    Description: Refresh, Rebuild or, Rescan failures

    Notification frequency: Instantly

    JSON filter:

      {  
        "content":{},
        "operations":[  
          "REFRESH", "FULL_REFRESH", "REBUILD"
        ],
        "resourceTypes":[  
          "SOURCE"
        ],
        "resultTypes":[  
          "ERROR"
        ]
      }
    

    Notification type: Email JSON

  • You want to receive a daily report of changes occurring in the API Keys page via webhook (see API Keys - Page). You configure a notification as follows:

    Name: API key changes

    Description: Any change in the API Keys page

    Notification frequency: Daily

    JSON filter:

      {  
        "content":{},
        "operations":[  
          "ENABLE", "CREATE", "CONFIG_CHANGE", "DISABLE", "DELETE"
        ],
        "resourceTypes":[  
          "API_KEY"
        ],
        "resultTypes":[  
          "*"
        ]
      }
    

    Notification type: Webhook