Skip to main content

PON Outage Notification Model

This document describes the structure of PON outage notifications sent to customer webhook endpoints when network issues are detected or resolved.

Overview

When a PON outage is detected, updated, or cleared, the system sends a message to configured webhook endpoint. The request body contains a JSON payload conforming to the structure described below.

Model Structure

Root Object: Pon Outage Notification Model

FieldTypeRequiredDescription
issuestringYesAlways set to "pon-outage" for PON outage notifications
timestampstring (ISO 8601)YesTimestamp when the network issue was registered (UTC)
tenantstringNoTenant name/identifier. May be null
outage_statusstringYesCurrent status of the outage (see Outage Status Values)
affected_subscribersarrayYesList of subscribers affected by this PON outage (see Affected Subscribers)

Affected Subscribers

Each entry in the affected_subscribers array has defined structure:

FieldTypeRequiredDescription
account_idstringYesUnique identifier for the affected subscriber's account
onu_serial_numberstringYesSerial number of the Optical Network Unit (ONT) device
citystringNoGeographic city where the affected subscriber is located. May be null
pon_portstringNoPON port identifier (e.g., "1/0/1@1/1/1"). May be null

Outage Status Values

The outage_status field can have one of the following values:

ValueDescription
"detected"A new outage has been detected or an existing outage has been updated
"cleared"The outage has been resolved
"undefined"The outage status could not be determined

Note: Both "raised" and "updated" statuses from the upstream system are mapped to "detected" in the notification.

Example Payload

{
"issue": "pon-outage",
"timestamp": "2025-10-06T12:28:08.958256Z",
"tenant": "adtran",
"outage_status": "detected",
"affected_subscribers": [
{
"account_id": "123",
"onu_serial_number": "serial-number",
"city": "Huntsville",
"pon_port": "1/0/1@1/1/1"
}
]
}