Notification Object

info

The English user guide is currently in beta preview. Most of the documents have been automatically translated from the Japanese version. Should you find any inaccuracies, please reach out to Flatt Security.

The Notification object refers to the structure or object outputted to Shisho Cloud when the policies attached to jobs within a workflow trigger notifications to Shisho Cloud.

Schema

type PolicyOutput = {
  message: string;

  target:
    | {
        notification_group: {
          id: id;
        };
      }
    | {
        email: {
          email: email;
        };
      }
    | {
        slack_channel: {
          slack_workspace_id: {
            id: string;
          };
          channel_id: {
            id: channel_id;
          };
        };
      }
    | {
        github_issue: {
          owner: string;
          repo: string;
          issue_id: number;
        };
      };
};

message Field

The message field takes the actual string to be notified as its value.

target Field

The target field takes the destination of the notification as its value.