Activity Log notifications

4 min

You can log important account-level events to the Optimizely Connect Platform (OCP) Activity Log using the App SDK's notifications.

The OCP Activity Log provides detailed information regarding significant activity, like data or file load jobs, integration syncs, and more. Each notification is made up of the following fields:

activity – Typically an enumerated set of values that represent the activity being logged. Maps to the Activity column in the OCP Activity Log table.

title – Title for the activity being logged. Maps to the View Details column in the ODP Activity Log table.

summary – Summary of the activity being logged. Should include important information related to the activity. Maps to the View Details column in the ODP Activity Log table.

(Optional) details – By default, the combination of title + summary is used to create the details of the entry. By supplying this optional field, you can provide additional details regarding the notification. Maps to the Details and View Details columns in the ODP Activity Log table.

In addition to these fields, notification entries also include a related status, which is one of the following:

info

success

warn

error

Enable notifications with the App SDK

The App SDK exposes the notifications feature through the notifications instance, which you can import as follows:

import {notifications} from '@zaiusinc/app-sdk';

The notifications instance follows the App SDK's Notifier interface.

export interface Notifier {
  /**
   * Create an informational notification.
   * @param activity The activity
   * @param title The title
   * @param summary The activity summary
   * @param [details] The activity details
   */
  info(activity: string, title: string, summary: string, details?: string): void;

  /**
   * Create a success notification.
   * @param activity The activity
   * @param title The title
   * @param summary The activity summary
   * @param [details] The activity details
   */
  success(activity: string, title: string, summary: string, details?: string): void;

  /**
   * Create a warning notification.
   * @param activity The activity
   * @param title The title
   * @param summary The activity summary
   * @param [details] The activity details
   */
  warn(activity: string, title: string, summary: string, details?: string): void;

  /**
   * Create an error notification.
   * @param activity The activity
   * @param title The title
   * @param summary The activity summary
   * @param [details] The activity details
   */
  error(activity: string, title: string, summary: string, details?: string): void;
}

To send a notification, call the appropriate method on the notifications instance.

notifications.success('Nightly Import Job', 'Import succeeded', 'Imported 10 items', 'Details');

Review the Activity Log

To access and review the log's information:

Go to Settings > Activity Log in the OCP UI.

Use the Category, Activity, and Status drop-down lists to refine the log's results.