Skip to content

NotificationEventSummary

Source code in docs_src/capo_notifications/types/notification_event_summary.py
class NotificationEventSummary(TypedDict, closed=True):
    schema_version: "capo_notifications.types.schema_version.SchemaVersion"
    """<p>The schema version of the Notification Event.</p>"""
    source_event_metadata: "capo_notifications.types.source_event_metadata_summary.SourceEventMetadataSummary"
    """<p>The source event metadata.</p>"""
    message_components: (
        "capo_notifications.types.message_components_summary.MessageComponentsSummary"
    )
    """<p>The message components of a notification event.</p>"""
    event_status: "capo_notifications.types.event_status.EventStatus"
    """<p>Provides additional information about the current status of the <code>NotificationEvent</code>.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>HEALTHY</code> </p> <ul> <li> <p>All <code>EventRules</code> are <code>ACTIVE</code>.</p> </li> </ul> </li> <li> <p> <code>UNHEALTHY</code> </p> <ul> <li> <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p> </li> </ul> </li> </ul> </li> </ul>"""
    notification_type: "capo_notifications.types.notification_type.NotificationType"
    """<p>The type of event causing the notification.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ALERT</code> </p> <ul> <li> <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p> </li> </ul> </li> <li> <p> <code>WARNING</code> </p> <ul> <li> <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p> </li> </ul> </li> <li> <p> <code>ANNOUNCEMENT</code> </p> <ul> <li> <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p> </li> </ul> </li> <li> <p> <code>INFORMATIONAL</code> </p> <ul> <li> <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p> </li> </ul> </li> </ul> </li> </ul>"""

event_status instance-attribute

event_status: EventStatus

Provides additional information about the current status of the NotificationEvent.

  • Values:

    • HEALTHY

      • All EventRules are ACTIVE.

    • UNHEALTHY

      • Some EventRules are ACTIVE and some are INACTIVE.

message_components instance-attribute

message_components: MessageComponentsSummary

The message components of a notification event.

notification_type instance-attribute

notification_type: NotificationType

The type of event causing the notification.

  • Values:

    • ALERT

      • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

    • WARNING

      • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

    • ANNOUNCEMENT

      • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

    • INFORMATIONAL

      • A notification about informational messages. For example, recommendations, service announcements, or reminders.

schema_version instance-attribute

schema_version: SchemaVersion

The schema version of the Notification Event.

source_event_metadata instance-attribute

source_event_metadata: SourceEventMetadataSummary

The source event metadata.