Untitled

The ServiceModified notification is sent when a service modification has been done by the nbn.

Note: Sending ServiceModified webhook notification for Service Plan Change is deprecated and will be removed shortly. Please move to dedicated ServicePlanChanged and ServicePlanChangeRejected webhooks events for any plan change modification request.

Along with the headers listed on the main Superloop Connect page, the request headers that are sent with the request to the callback URL includes the following:

Table 1. Webhook Event Notification Request Headers
Header	Value
z-event-type	service.modified.event
z-notification-type	service.modified.notification
z-notification-model	service

The payload of the notification will include the configuration of the service as well as the ID of the 360 service.

Example payload of the ServiceModified webhook notification where Aggregation Method is L2TP

{
    "customerRef": "735",
    "nbnServiceActivatedOn": "2020-12-16T09:24:34Z",
    "technologyType": "HFC",
    "trafficClass": "TC4",
    "locId": "LOC000000000001",
    "avcId": "AVC000000000001",
    "vlanId": "100",
    "poi": "4CAB Caboolture",
    "region": "Urban",
    "eSla": "Standard",
    "bandwidthProfile": {
        "speedDown": 100,
        "speedUp": 20,
        "planName": "Home Fast 100/20",
        "cvcInclusion": 2.25
    },
    "infrastructure": {
        "id": "CPI000000000001",
        "portId": "1",
        "productId": "PRI000000000001"
    },
    "address": {
    "buildingLevel": null,
    "unitNumber": "9",
    "buildingName": null,
    "streetNumber": "5",
    "street": "Burpengary Road",
    "suburb": "Burpengary",
    "state": "Queensland",
    "postcode": "4505",
    "formattedAddress": "5 Burpengary Rd, Burpengary QLD 4505, Australia"
    },
    "modifiedOn": "2021-03-09",
    "id": 123656,
    "aggregationMethod": "L2TP",
    "subscriberSTag": null,
    "subscriberCTag": null,
    "dslStabilityProfile": null,
    "isNfas": false,
    "hasNfasCommitment": false,
    "nfasCommitmentExpiresOn": null,
    "legacyTechnologyType": null
}

Example payload of the ServiceModified webhook notification where Aggregation Method is ETHERNET

{
    "customerRef": "735",
    "nbnServiceActivatedOn": "2020-12-16T09:24:34Z",
    "technologyType": "HFC",
    "trafficClass": "TC4",
    "locId": "LOC000000000001",
    "avcId": "AVC000000000001",
    "vlanId": "100",
    "poi": "4CAB Caboolture",
    "region": "Urban",
    "eSla": "Standard",
    "bandwidthProfile": {
        "speedDown": 100,
        "speedUp": 20,
        "planName": "Home Fast 100/20",
        "cvcInclusion": 2.25
    },
    "infrastructure": {
        "id": "CPI000000000001",
        "portId": "1",
        "productId": "PRI000000000001"
    },
    "address": {
    "buildingLevel": null,
    "unitNumber": "9",
    "buildingName": null,
    "streetNumber": "5",
    "street": "Burpengary Road",
    "suburb": "Burpengary",
    "state": "Queensland",
    "postcode": "4505",
    "formattedAddress": "5 Burpengary Rd, Burpengary QLD 4505, Australia"
    },
    "modifiedOn": "2021-03-09",
    "id": 123656,
    "aggregationMethod": "ETHERNET",
    "dslStabilityProfile": null,
    "subscriberSTag": 1011,
    "subscriberCTag": 2910,
    "isNfas": false,
    "hasNfasCommitment": false,
    "nfasCommitmentExpiresOn": null,
    "legacyTechnologyType": null
}

Table 2. Fields specific to ServiceModified
Field	Explanation
`modifiedOn`	The date/time, including UTC offset, when the service has been modified.

Table 3. Fields for all Service based webhooks
Field	Explanation
`customerRef`	The reference string that you provided when you placed the order
`nbnServiceActivatedOn`	The date the nbn enabled the service on their end
`technologyType`	The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below
`trafficClass`	The nbn traffic class, e.g. `TC4`
`locId`	The nbn LOC ID of the address of the site the order is for
`avcId`	The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site
`vlanId`	The VLAN that was specified at order time
`poi`	The code of the nbn POI that the site is serviced from
`region`	The nbn region identifier that nbn places the site in. Possible values are: `Major Rural` `Minor Rural` `Remote` `Urban` `Isolated Area` `Limited Access Area`
`eSla`	The level of restoration SLA that the service has
`bandwidthProfile`	An object that contains details on the bandwidth profile that was selected for the service
`bandwidthProfile.speedDown`	The download speed of the service, in mbps
`bandwidthProfile.speedUp`	The upload speed of the service, in mbps
`bandwidthProfile.planName`	The name of the plan that was selected for the service
`bandwidthProfile.cvcInclusion`	The CVC inclusion that is applied to CVC rebates, if applicable
`infrastructure`	Information about the infrastructure at the site, including NTDs and Copper Pairs
`infrastructure.id`	The nbn identifier of the equipment
`infrastructure.portId`	The port on the device that was chosen for the service. Only for NTD infrastructure
`infrastructure.productId`	The nbn identifier of the product component that is activated for the Customer
`address`	The address of the site where the service is being provided
`address.buildingLevel`	The level that the site is on, if applicable
`address.unitNumber`	The unit number of the site, if applicable
`address.buildingName`	The name of the building, if applicable
`address.streetNumber`	The street number of the site
`address.street`	The name of the street, including street type
`address.suburb`	The suburb
`address.state`	The state
`address.postcode`	The postcode
`address.formattedAddress`	The whole address, formatted in a single line
`id`	The ID of the 360 service that the order fulfils
`aggregationMethod`	The aggregation method of the order. Possible values are: `L2TP` `ETHERNET`
`subscriberSTag`	The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`
`subscriberCTag`	The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`
`isNfas`	Indicates whether the service is a nbn Co’s Fibre Access Service (NFAS). Possible values are: `true` `false`
`hasNfasCommitment`	Nbn is required to apply Fiber Upgrade Early Termination Fee on cancellation or downgrade to a lower speeds tiers for an NFAS service. The hasNfasCommitment field indicates customer’s commitment for a period of time for which Customer is committed to pay. Possible values are: `true` `false` `hasNfasCommitment` as `true` indicates customer’s commitment not to cancel or downgrade the service below a minimum speed, and charge will be applied if broken. `hasNfasCommitment` as `false` indicates either your service never had the commitment or the commitment period has expired or the fee was already applied. See below table for Fibre Upgrade Early Termination Fee applicable plans.
`nfasCommitmentExpiresOn`	Fiber Upgrade Early Termination Fee will be charged on a cancellation or downgrade of the service to a lower speeds tiers for an NFAS service during this time period. The nfasCommitmentExpiresOn indicates the date until when the customer is committed to Fiber Upgrade Early Termination Fee. Only set when the service is a nbn Co’s Fibre Access Service (NFAS)
`legacyTechnologyType`	Legacy nbn technology type of the the service if the service is NFAS otherwise NULL
`dslStabilityProfile`	The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are: `Standard` `Stable`

Table 4. nbn Technology Type Map
Acronym	Description
FTTP	Fibre to the Premises
FTTB	Fibre to the Building
FTTN	Fibre to the Node
FTTC	Fibre to the Curb
HFC	Hybrid Fibre-Coaxial
FW	Fixed Wireless
SAT	Satellite

Table 5. Fibre Upgrade Early Termination Fee Applicable plans
Legacy Technology Type	Chargeable NBN Plans
FTTN	Home Fast 12/1
FTTN	Home Fast 25/5
FTTN	Home Fast 25/10
FTTN	Home Fast 50/20
FTTN	Home Fast 100/20
FTTC	Home Fast 12/1
FTTC	Home Fast 25/5
FTTC	Home Fast 25/10
FTTC	Home Fast 50/20
FTTC	Home Fast 100/20
FTTC	Home Fast 100/40