Superloop Connect

    IF access technology type is FTTP THEN
        IF port is Free THEN
            IF (remainingDownstreamBandwidth - plan's speed down < 0Mbps OR
                remainingUpstreamBandwidth - plan's speed up < 0Mbps) THEN
                    "Not enough capacity on existing NTD to support plan."
                    "Order an additional NTD."
        IF port in Use THEN
            "As the speed of the current service on the port is unknown,"
            "it cannot be determined if the plan would exceed the NTD's remaining capacity."
            "In this scenario, it is suggested the order is placed, and it will fail if capacity is exceeded."

{
   "generationOneNtdPlans":[
      {
         "name":"Home Fast 25/5",
         "type":"RESIDENTIAL",
         "speedDown":25,
         "speedUp":5,
         "ntdOptions":[

         ]
      }
  ]
}

{
   "generationTwoNtdPlans":[
      {
         "name":"Home Fast 25/5",
         "type":"RESIDENTIAL",
         "speedDown":25,
         "speedUp":5,
          "ntdOptions":[
         ]
      },
      {
         "name":"Home Hyperfast 2000/500",
         "type":"BUSINESS",
         "speedDown":250,
         "speedUp":100,
         "ntdOptions":[
         ]
      }
  ]
}

{
     "infrastructures":[
        {
          ...
          "ntdType":"Internal",
          "ntdVersion":"V1",
          "plans": "generationOneNtdPlans",
          ...
        }
    ]
}

    "replacementNtds": [
        {
            "name": "4_PORT_REPLACEMENT",
            "ntdType": "4_PORT",
            "ntdVersion": "V4",
            "ntdPlanTypes": [
                "RESIDENTIAL",
                "BUSINESS"
            ],
            "fees": []
        }
    ],
    ...
    "infrastructures":[
        {
          "infrastructureId":"NTD151638001427",
          "ntdType":"1_PORT",
          "ntdVersion":"V3",
          ...
          "ntdPorts":[
            {
               "portId":"1",
               "portName":"1-UNI-D1",
               "uniType":"UNI-D",
               "status":"Used",
               ...
            }
          ],
          ...
          "replacementNtdPlans": [
            {
               "name":"Home Fast 100/20",
               "type":"RESIDENTIAL",
               "speedDown":100,
               "speedUp":20,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            },
            {
               "name":"Home Superfast 250/25",
               "type":"RESIDENTIAL",
               "speedDown":250,
               "speedUp":25,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            },
            {
               "name":"Home Ultrafast 1000/50",
               "type":"RESIDENTIAL",
               "speedDown":1000,
               "speedUp":50,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            }
         ],
         "replacementNtdInstallationOptions":[
            {
               "option":"nbn-tech",
               "recommended":true,
               "fees":[

               ],
               "hardwareShortfall":true
            }
         ]

    "replacementNtds": [
        {
            "name": "4_PORT_REPLACEMENT",
            "ntdType": "4_PORT",
            "ntdVersion": "V4",
            "ntdPlanTypes": [
                "RESIDENTIAL",
                "BUSINESS"
            ],
            "fees": []
        }
    ],
    ...
    "infrastructures":[
        {
          "infrastructureId":"NTD151638001427",
          "ntdType":"1_PORT",
          "ntdVersion":"V3",
          ...
          "ntdPorts":[
            {
               "portId":"1",
               "portName":"1-UNI-D1",
               "uniType":"UNI-D",
               "status":"Used",
               ...
            }
          ],
          ...
          "replacementNtdPlans": [
            {
               "name":"Home Fast 100/20",
               "type":"RESIDENTIAL",
               "speedDown":100,
               "speedUp":20,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            },
            {
               "name":"Home Superfast 250/25",
               "type":"RESIDENTIAL",
               "speedDown":250,
               "speedUp":25,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            },
            {
               "name":"Home Ultrafast 1000/50",
               "type":"RESIDENTIAL",
               "speedDown":1000,
               "speedUp":50,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            }
         ],
         "replacementNtdInstallationOptions":[
            {
               "option":"nbn-tech",
               "recommended":true,
               "fees":[

               ],
               "hardwareShortfall":true
            }
         ]

{
         "replacementPlans": [
                {
                    "name": "Home Fast 25/5",
                    "type": "RESIDENTIAL",
                    "speedDown": 25,
                    "speedUp": 5,
                    "ntdOptions": [
                        "4_PORT_REPLACEMENT"
                    ]
                },
                ...
         ]
}

{
   "planName" : "Home Fast 25/5",  (additional service)
   "infrastructureId": "NTD151638001599", (must be set)
   "ntdPortId": null, (must be null)
   "ntdOption": "4_PORT_REPLACEMENT", (replacement NTD option)
   "ntdInstallationOption": "nbn-tech", (installation option for replacement NTD)
   ...
}


== Service Plan Change Enhancements
To show what plans are offered and what NTD's can be chosen, the plan change options response had the following added to it for FTTP and HFC
access technology types:

*For FTTP and HFC*

. *ntdOptions*. An array containing available NTD options and any associated costs.

* If the current NTD is *Generation One & download speed > 1000 MBit/s*, this array will contain one or more entries, each detailing an available upgrade option and its cost (if applicable).
* If the current NTD is *Generation Two*, this array will be empty, as no upgrade is needed or available.

*Important*

* When selecting plans with speeds greater than 1000 MBit/s, you must include a valid ntdOption along with the contact details in the request payload. These high-speed plans are not compatible with Generation one NTDs, and an upgrade must be specified.

*For FTTP Only*

. *requiresAdditionalNtd*. A Boolean value indicating whether an additional Network Termination Device (NTD) is required for the plan.
. *requiresAdditionalNtdReason*. If an additional NTD is required, this field explains the reason.

Possible values include:

1. BANDWIDTH_CAPACITY_EXCEEDED - The current NTD will exceed its remaining bandwidth capacity with the desired plan.
2. BATTERY_BACKUP - NBN Co has ceased supplying battery backup units for Fibre to the Premises (FTTP), requiring an additional NTD order.

*Important*

* In either of these scenarios, you must order an additional NTD along with the desired plan.

==== Generation One Example
* ntdOptions available for a generation one NTD.

[source,json]

==== Generation Two Example
* ntdOptions not available for a generation two NTD.

[source,json]

==== Service Plan Change Request with ntdOption Example

[source,json]

== Webhooks
Appointment webhooks have a new field "appointmentFor" added. This field can have a value of ORDER or SERVICE_PLAN_CHANGE.
It indicates if the appointment is due to an order or a service plan change.

At the moment, only the following subset of appointment notifications are implemented for a service plan
change. Those notifications can have either of the two values. The rest will always have ORDER as the value.

* AppointmentBooked
* AppointmentRescheduled
* AppointmentCompleted

[source]

== Introduction

Superloop Connect is an automated platform for ordering services from Superloop.

Connect is provided by Superloop's service management software - 360. 360 is what powers the Superloop portal at;

.Portal Application URL for each environment
[cols="2,4"]
|===
|Environment |URL

|Production
|https://portal.superloop.com

|Sandbox
|https://portal-sandbox.superloop.com/
|===

== Connect API

This document will guide you in using the Superloop Connect API (Connect API for short) so that you can automate the provisioning of services through Superloop.

== Getting Access

In order to use the Connect API, your organisation must have:

1. been approved for Superloop Connect through your account manager at Superloop
2. been given an OAuth 2 authentication profile
3. a Superloop Contact configured as the 'API User'

Your account manager at Superloop will be able to organise these things for you.

If you are unsure who your account manager is, log in to the Superloop portal at https://portal.superloop.com/360.

You will see a field named "Account Manager".

If you do not have an account manager, or you can't log into the Superloop portal, please contact the support team at support@superloop.com or contact the Superloop team member that you have been liaising with.

== API Sections

There are two parts to automated Connect access: the API and Webhooks.

=== API

The Connect API is a REST over HTTP API that you use to qualify sites and order services with. This API is what your application will connect to.


==== Introduction
API endpoints are for use by applications written by Superloop customers.

All Connect API endpoints start with;

.API Endpoint for each environment
[cols="2,4"]
|===
|Environment |Endpoint

|Production
|`/api`, `https://360-api.superloop.com/api`

|Sandbox
|`/api`, `https://360-api-sandbox.superloop.com/api`
|===


==== Authentication
Before making a HTTP request to Connect API, you will need to have obtained an Access Token. This is a Bearer Token
and will be passed in via the Authorization Header. +
Read more: <<api/authentication.adoc#, Authentication>>


==== Accessing Endpoints

When making HTTP requests to Connect API, you will need to provide the following request headers on every request:

1. Bearer Token
2. API Version

This applies to all requests to endpoints that start with `/api`.

===== Bearer Token

The bearer token authenticates the HTTP request with Connect API. Bearer tokens are obtained by authenticating with Superloop's single sign on server at;

.Authentication Token Endpoint for each environment
[cols="2,4"]
|===
|Environment |Endpoint

|Production
|https://sso.superloop.com/auth

|Sandbox
|https://sso-sandbox.superloop.com/auth
|===

.Example Bearer Token

Instructions on how to authenticate are coming soon.

===== API Version

Connect API is a versioned API. This is done in order to provide API clients time to update their software to work with breaking changes to the API.

With new functionality comes changes to the API over time. The Connect team endeavour to make changes to the API non-breaking as much as possible. This means that whenever we add functionality to Connect, we try to make it so that we only add new fields to an API endpoint's request and response, and that those fields are optional.

This is not always possible, though. Sometimes we need to either add new fields that are required or we need to remove fields altogether. When this happens, we create a new API version that contains the changes. Client applications then have to opt in to using the new API version. The previous API version is kept live so that clients that haven't migrated to the new version can still function.

NOTE: Sometimes it's not possible to keep the previous API version when a new one is released. If this occurs, the Connect team will not deploy the new version until we know all client applications are migrated.

Every request to endpoints require a header named `X-API-VERSION`, with the version number being the value of the header.

.Example API Version header

==== Version Numbering

The API version starts at `1`. Every subsequent API version is an increment of the last. The next API version will be `2`.

All endpoints adopt new version numbers, even if they didn't need to change. This allows client applications to use a single API version across all requests.

==== Version Sunsetting

In order to keep Connect's code clean, the Connect team will remove older API version code from Connect. The team will only do this when it is confirmed that all clients no longer use the version.

Customers will be informed of new versions when they're about to be released. Usually you will not have to do anything about the new version right away.

There will be times when the Connect team needs to remove an older version before they can deploy a new version. In this case, all customers will be contacted and asked to move to the current version so that the team can deploy the new version.

==== API Testing

You can test the API using our sandbox environment.

* Sandbox Portal Application:  https://portal-sandbox.superloop.com/
* Sandbox API Base URL: https://360-api-sandbox.superloop.com/api
* Sandbox Authentication Token Endpoint: https://sso-sandbox.superloop.com/auth/realms/superloop/protocol/openid-connect/token

Please note the following:

* While the authentication token endpoints differ between the sandbox and production environments, both require the same client ID and certificates for JWT signing.

* Your user credentials (username and password) remain the same across both environments.

== Endpoints

=== Location Search
Search for Locations to use in a Service Qualifications +
<<api/endpoints/location-searches.adoc#,/api/connect/location-searches>>

=== Service Qualification
Qualify a Location +
<<api/endpoints/qualifications.adoc#,/api/connect/qualifications>>

=== Orders
Create, Get or Cancel an Order +
<<api/endpoints/orders.adoc#,/api/connect/orders>>

=== Appointments
Get Appointment Slots, Book an Appointment or Cancel an Appointment +
<<api/endpoints/appointments.adoc#,/api/connect/orders/appointments>>

=== Services
Get a Service, Perform a Plan Change, Perform Diagnostic Tests, Cancel a Service, Reclaim a Service, Get Service Disruptions, Convert the
aggregation method of a Service, Change a Service's DSL Stability Profile or perform a Service Health Check +
<<api/endpoints/services.adoc#,/api/connect/services>>

=== Locations
Get Change of Access Technology details for a Location +
<<api/endpoints/locations.adoc#,/api/connect/locations>>

=== Fibre Build Charges
Get the File Build Charge for a Location +
<<api/endpoints/fibre-build-charges.adoc#,/api/connect/ee/quotes>>

=== Errors
* <<api/errors/errors.adoc#,Errors>>


== Webhooks

360 can notify your system of certain events relating to orders and services.

Go to the Webhooks section to find out about the events that Superloop Connect can notify your application about.

=== Introduction

Connect API - Webhooks is the way Superloop 360 notify your selected callback urls of any subscribed events relating to orders and services.

=== Webhook Configuration

In order to receive webhook notifications, you will need to set up one or more callback URLs in Superloop 360. Instructions can be found   <<webhooks/webhook-configuration.adoc#,here>>.

=== Webhook Notification Requests

Connect will send your webhook URLs notifications for a number of key events. These notifications are POST requests. These POST requests are comprised of:

1. the notification payload as the POST request body. This provides your application with detailed information about the event.
2. request headers, which include important metadata that your application can use to decide what to do with the request.

The notification payload is different very each type of event that Connect notifies you of. There is a detailed explanation of each even's payload in the "Event Types" section below.

The request headers, and their meaning, is outlined in the table below.

.Webhook Event Notification Request Headers
[cols="2, 3, 2"]
|====
|Header|Meaning|Example Value

|z-event-date-time
|When the event was raised, not necessarily when it was sent
|2021-04-06T22:27:35Z[Etc/UTC]

|z-event-type
|The type of event that the notification is for
|order.accepted.event

|z-notification-type
|The type of notification
|order.accepted.notification

|z-notification-model
|The type of resource that the notification is about
|order

|z-notification-id
|The unique id of the notification
|d2a3065b-4e58-4925-b216-a4b3da99a0c0

|user-agent
|This is always 'Superloop-Portal-API'
|Superloop-Portal-API

|signature
|The hash of the request body and your webhook secret that you set up in 360
|279a13898ce22b004c9d165787e4899e0...
|====


=== Verifying Webhook Notification Requests

Before you use the data provided by a webhook notification request, you must verify it by its signature and payload. Verifying the request ensures that the webhook came from Superloop and not a third party.

The signature is in the 'signature' head of the request. The signature is the HmacSHA256 hash of the secret and the payload

The payload is the POST body of the request.

You must hash the payload with the webhook secret that you set up in the webhooks section of your company's 360 profile, under the integrations menu item.

https://portal.superloop.com/360/integrations/webhooks[Click here to go to your company's webhook configuration.]

.Example Signature Verification - Java
[source,java]

.Example Signature Verification - PHP
[source,php]

=== Webhook Retry Schedule

When an event occurs in 360, a notification is sent to all callback url(s) that a company has registered to receive a notification of said event.

If a notification fails to be delivered, or an error response is received, it is rescheduled to be resent for up to 6 attempts with a delay between each retry as listed below:

.Webhook Retry Schedule
[cols="1, 3"]
|====
|Attempt #| Delay until next attempt

|1 (Initial Send)
|Up to 60 seconds

|2
|1 minute

|3
|5 minutes

|4
|30 minutes

|5
|4 hours

|6
|8 hours

|7
|No more retries

|====


=== Resend Notification

To resend a notification, please follow instructions below:

. Select *Integrations* from the left side menu then click on the *Notifications* option.

. Find the notification you wish to resend and click on the *Resend Notification* button.

Your notification will be sent following the <<#_webhook_retry_schedule,Webhook Retry Schedule>>.

image:./images/manualRetry.PNG[]

=== Event Types

This is the list of events that the webhooks system sends your call back URLs. Click on each one to find out more about them.

==== Appointment Events

===== Appointment Booked
[[top-appointment-booked]]
:docinfo1:

The `AppointmentBooked` notification is sent when an appointment you have has been validated successfully by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|appointment.booked.event

|z-notification-type
|appointment.booked.notification

|z-notification-model
|appointment
|===


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

.Example payload of the `AppointmentBooked` webhook notification for an order

.Example payload of the `AppointmentBooked` webhook notification for a service plan change

.Fields specific to AppointmentBooked
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`bookedOn`
a|The date/time, including UTC offset, when nbn validated the appointment.
|===

.Fields for all Appointment based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the appointment.

a|`nbnAppointmentId`
a|The NBN identifier of the appointment.

a|`orderId`
a|The Order ID uniquely identifies an order that has been placed with NBN Co.

a|`appointmentFor`
a|ORDER \| SERVICE_PLAN_CHANGE. Indicates if the appointment is required due to an order or a service plan change.

a|`serviceId`
a|The ID of the 360 service.

a|`status`
a|The status of the appointment.

* `Reserved` - NBN Co allocates a unique Appointment ID when customer reserves an appointment, and the id must
be included in the order. Customer is awaiting appointment validation by NBN in this stage.

* `Booked`  - A `Reserved` Appointment will become a `Booked` Appointment if validated successfully by NBN Co.

* `In Progress` -  NBN Co is undertaking necessary fieldwork for the Appointment.

* `Complete` - The end stage of an Appointment that has completed.

* `Incomplete` - NBN Co notifies Customer that an Appointment could not commence and/or could not be completed as scheduled.

* `Cancelled` - Customer or NBN Co has cancelled an Appointment.

a|`startTime`
a|The date/time, including UTC offset, appointment start time will be visible only when appointment has been confirmed.

a|`endTime`
a|The date/time, including UTC offset, appointment end time, will be visible only when appointment has been confirmed.

a|`slotType`
a|The type of confirmed appointment slot. AM/ PM.

a|`timezoneOffset`
a| Represents an offset defined in a Timezone.

a|`priorityAssist`
a|Indicates whether the appointment is priority assisted or not.

a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.

a|`demandType`
a|The type of installation the appointment slot is provided for.

a|`contact`
a|The contact details of the appointment.

a|`contact.name`
a|The name of the contact.

a|`contact.type`
a|The type of the contact.

a|`contact.phone`
a|The number of the contact.

a|`contact.notes`
a|Additional information. If any.

a|`customerRef`
a|The reference string that you provided when you placed the order.
|===

===== Appointment Cancelled
:docinfo1:

The `AppointmentCancelled` notification is sent when an appointment you have has been cancelled by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|appointment.cancelled.event

|z-notification-type
|appointment.cancelled.notification

|z-notification-model
|appointment
|===


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

.Example payload of the `AppointmentCancelled` webhook notification

.Fields specific to AppointmentCancelled
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`cancelledOn`
a|The date/time, including UTC offset, when the nbn cancelled the appointment.
|===

.Fields for all Appointment based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the appointment.

a|`nbnAppointmentId`
a|The NBN identifier of the appointment.

a|`orderId`
a|The Order ID uniquely identifies an order that has been placed with NBN Co.

a|`appointmentFor`
a|ORDER \| SERVICE_PLAN_CHANGE. Indicates if the appointment is required due to an order or a service plan change.

a|`serviceId`
a|The ID of the 360 service.

a|`status`
a|The status of the appointment.

* `Reserved` - NBN Co allocates a unique Appointment ID when customer reserves an appointment, and the id must
be included in the order. Customer is awaiting appointment validation by NBN in this stage.

* `Booked`  - A `Reserved` Appointment will become a `Booked` Appointment if validated successfully by NBN Co.

* `In Progress` -  NBN Co is undertaking necessary fieldwork for the Appointment.

* `Complete` - The end stage of an Appointment that has completed.

* `Incomplete` - NBN Co notifies Customer that an Appointment could not commence and/or could not be completed as scheduled.

* `Cancelled` - Customer or NBN Co has cancelled an Appointment.

a|`startTime`
a|The date/time, including UTC offset, appointment start time will be visible only when appointment has been confirmed.

a|`endTime`
a|The date/time, including UTC offset, appointment end time, will be visible only when appointment has been confirmed.

a|`slotType`
a|The type of confirmed appointment slot. AM/ PM.

a|`timezoneOffset`
a| Represents an offset defined in a Timezone.

a|`priorityAssist`
a|Indicates whether the appointment is priority assisted or not.

a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.

a|`demandType`
a|The type of installation the appointment slot is provided for.

a|`contact`
a|The contact details of the appointment.

a|`contact.name`
a|The name of the contact.

a|`contact.type`
a|The type of the contact.

a|`contact.phone`
a|The number of the contact.

a|`contact.notes`
a|Additional information. If any.

a|`customerRef`
a|The reference string that you provided when you placed the order.
|===


===== Appointment Completed
:docinfo1:

The `AppointmentCompleted` notification is sent when an appointment you have has been completed by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|appointment.completed.event

|z-notification-type
|appointment.completed.notification

|z-notification-model
|appointment
|===


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

.Example payload of the `AppointmentCompleted` webhook notification for an order

.Example payload of the `AppointmentCompleted` webhook notification for a service plan change

.Fields specific to AppointmentCompleted
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`completedOn`
a|The date/time, including UTC offset, when the nbn completed the appointment.
|===

.Fields for all Appointment based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the appointment.

a|`nbnAppointmentId`
a|The NBN identifier of the appointment.

a|`orderId`
a|The Order ID uniquely identifies an order that has been placed with NBN Co.

a|`appointmentFor`
a|ORDER \| SERVICE_PLAN_CHANGE. Indicates if the appointment is required due to an order or a service plan change.

a|`serviceId`
a|The ID of the 360 service.

a|`status`
a|The status of the appointment.

* `Reserved` - NBN Co allocates a unique Appointment ID when customer reserves an appointment, and the id must
be included in the order. Customer is awaiting appointment validation by NBN in this stage.

* `Booked`  - A `Reserved` Appointment will become a `Booked` Appointment if validated successfully by NBN Co.

* `In Progress` -  NBN Co is undertaking necessary fieldwork for the Appointment.

* `Complete` - The end stage of an Appointment that has completed.

* `Incomplete` - NBN Co notifies Customer that an Appointment could not commence and/or could not be completed as scheduled.

* `Cancelled` - Customer or NBN Co has cancelled an Appointment.

a|`startTime`
a|The date/time, including UTC offset, appointment start time will be visible only when appointment has been confirmed.

a|`endTime`
a|The date/time, including UTC offset, appointment end time, will be visible only when appointment has been confirmed.

a|`slotType`
a|The type of confirmed appointment slot. AM/ PM.

a|`timezoneOffset`
a| Represents an offset defined in a Timezone.

a|`priorityAssist`
a|Indicates whether the appointment is priority assisted or not.

a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.

a|`demandType`
a|The type of installation the appointment slot is provided for.

a|`contact`
a|The contact details of the appointment.

a|`contact.name`
a|The name of the contact.

a|`contact.type`
a|The type of the contact.

a|`contact.phone`
a|The number of the contact.

a|`contact.notes`
a|Additional information. If any.

a|`customerRef`
a|The reference string that you provided when you placed the order.
|===

===== Appointment Failed
:docinfo1:

The `AppointmentFailed` notification is sent when an appointment you have scheduled or rescheduled has failed.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|appointment.failed.event

|z-notification-type
|appointment.failed.notification

|z-notification-model
|appointment
|===


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

.Example payload of the `AppointmentFailed` webhook notification

.Fields specific to AppointmentFailed
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`failedOn`
a|The date/time, including UTC offset, when the nbn failed the appointment.

a|`failedReason`
a|The reason why the appointment failed.
|===

.Fields for all Appointment based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the appointment.

a|`nbnAppointmentId`
a|The NBN identifier of the appointment.

a|`orderId`
a|The Order ID uniquely identifies an order that has been placed with NBN Co.

a|`appointmentFor`
a|ORDER \| SERVICE_PLAN_CHANGE. Indicates if the appointment is required due to an order or a service plan change.

a|`serviceId`
a|The ID of the 360 service.

a|`status`
a|The status of the appointment.

* `Reserved` - NBN Co allocates a unique Appointment ID when customer reserves an appointment, and the id must
be included in the order. Customer is awaiting appointment validation by NBN in this stage.

* `Booked`  - A `Reserved` Appointment will become a `Booked` Appointment if validated successfully by NBN Co.

* `In Progress` -  NBN Co is undertaking necessary fieldwork for the Appointment.

* `Complete` - The end stage of an Appointment that has completed.

* `Incomplete` - NBN Co notifies Customer that an Appointment could not commence and/or could not be completed as scheduled.

* `Cancelled` - Customer or NBN Co has cancelled an Appointment.

a|`startTime`
a|The date/time, including UTC offset, appointment start time will be visible only when appointment has been confirmed.

a|`endTime`
a|The date/time, including UTC offset, appointment end time, will be visible only when appointment has been confirmed.

a|`slotType`
a|The type of confirmed appointment slot. AM/ PM.

a|`timezoneOffset`
a| Represents an offset defined in a Timezone.

a|`priorityAssist`
a|Indicates whether the appointment is priority assisted or not.

a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.

a|`demandType`
a|The type of installation the appointment slot is provided for.

a|`contact`
a|The contact details of the appointment.

a|`contact.name`
a|The name of the contact.

a|`contact.type`
a|The type of the contact.

a|`contact.phone`
a|The number of the contact.

a|`contact.notes`
a|Additional information. If any.

a|`customerRef`
a|The reference string that you provided when you placed the order.
|===

===== Appointment Rescheduled Required
:docinfo1:

The `AppointmentRescheduleRequired` notification is sent when an appointment reschedule is required.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|appointment.reschedule-required.event

|z-notification-type
|appointment.reschedule-required.notification

|z-notification-model
|appointment
|===


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

.Example payload of the `AppointmentRescheduleRequired` webhook notification

.Fields specific to AppointmentRescheduleRequired
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`reason`
a|The reason why the appointment needs to be rescheduled.
|===

.Fields for all Appointment based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the appointment.

a|`nbnAppointmentId`
a|The NBN identifier of the appointment.

a|`orderId`
a|The Order ID uniquely identifies an order that has been placed with NBN Co.

a|`appointmentFor`
a|ORDER \| SERVICE_PLAN_CHANGE. Indicates if the appointment is required due to an order or a service plan change.

a|`serviceId`
a|The ID of the 360 service.

a|`status`
a|The status of the appointment.

* `Reserved` - NBN Co allocates a unique Appointment ID when customer reserves an appointment, and the id must
be included in the order. Customer is awaiting appointment validation by NBN in this stage.

* `Booked`  - A `Reserved` Appointment will become a `Booked` Appointment if validated successfully by NBN Co.

* `In Progress` -  NBN Co is undertaking necessary fieldwork for the Appointment.

* `Complete` - The end stage of an Appointment that has completed.

* `Incomplete` - NBN Co notifies Customer that an Appointment could not commence and/or could not be completed as scheduled.

* `Cancelled` - Customer or NBN Co has cancelled an Appointment.

a|`startTime`
a|The date/time, including UTC offset, appointment start time will be visible only when appointment has been confirmed.

a|`endTime`
a|The date/time, including UTC offset, appointment end time, will be visible only when appointment has been confirmed.

a|`slotType`
a|The type of confirmed appointment slot. AM/ PM.

a|`timezoneOffset`
a| Represents an offset defined in a Timezone.

a|`priorityAssist`
a|Indicates whether the appointment is priority assisted or not.

a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.

a|`demandType`
a|The type of installation the appointment slot is provided for.

a|`contact`
a|The contact details of the appointment.

a|`contact.name`
a|The name of the contact.

a|`contact.type`
a|The type of the contact.

a|`contact.phone`
a|The number of the contact.

a|`contact.notes`
a|Additional information. If any.

a|`customerRef`
a|The reference string that you provided when you placed the order.
|===


===== Appointment Rescheduled
:docinfo1:

The `AppointmentRescheduled` notification is sent when an appointment has been rescheduled by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|appointment.rescheduled.event

|z-notification-type
|appointment.rescheduled.notification

|z-notification-model
|appointment
|===


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

.Example payload of the `AppointmentRescheduled` webhook notification for an order

.Example payload of the `AppointmentRescheduled` webhook notification for a service plan change

.Fields specific to AppointmentRescheduled
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`rescheduledOn`
a|The date/time, including UTC offset, when nbn rescheduled the appointment.
|===

.Fields for all Appointment based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the appointment.

a|`nbnAppointmentId`
a|The NBN identifier of the appointment.

a|`orderId`
a|The Order ID uniquely identifies an order that has been placed with NBN Co.

a|`appointmentFor`
a|ORDER \| SERVICE_PLAN_CHANGE. Indicates if the appointment is required due to an order or a service plan change.

a|`serviceId`
a|The ID of the 360 service.

a|`status`
a|The status of the appointment.

* `Reserved` - NBN Co allocates a unique Appointment ID when customer reserves an appointment, and the id must
be included in the order. Customer is awaiting appointment validation by NBN in this stage.

* `Booked`  - A `Reserved` Appointment will become a `Booked` Appointment if validated successfully by NBN Co.

* `In Progress` -  NBN Co is undertaking necessary fieldwork for the Appointment.

* `Complete` - The end stage of an Appointment that has completed.

* `Incomplete` - NBN Co notifies Customer that an Appointment could not commence and/or could not be completed as scheduled.

* `Cancelled` - Customer or NBN Co has cancelled an Appointment.

a|`startTime`
a|The date/time, including UTC offset, appointment start time will be visible only when appointment has been confirmed.

a|`endTime`
a|The date/time, including UTC offset, appointment end time, will be visible only when appointment has been confirmed.

a|`slotType`
a|The type of confirmed appointment slot. AM/ PM.

a|`timezoneOffset`
a| Represents an offset defined in a Timezone.

a|`priorityAssist`
a|Indicates whether the appointment is priority assisted or not.

a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.

a|`demandType`
a|The type of installation the appointment slot is provided for.

a|`contact`
a|The contact details of the appointment.

a|`contact.name`
a|The name of the contact.

a|`contact.type`
a|The type of the contact.

a|`contact.phone`
a|The number of the contact.

a|`contact.notes`
a|Additional information. If any.

a|`customerRef`
a|The reference string that you provided when you placed the order.
|===


===== Appointment Errored
:docinfo1:

The `AppointmentErrored` notification is sent when an appointment you have scheduled or rescheduled has an error.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|appointment.errored.event

|z-notification-type
|appointment.errored.notification

|z-notification-model
|appointment
|===


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

.Example payload of the `AppointmentErrored` webhook notification

.Fields specific to AppointmentErrored
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`erroredOn`
a|The date/time, including UTC offset, when the nbn errored the appointment.

a|`erroredReason`
a|The reason why the appointment errored.
|===

.Fields for all Appointment based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the appointment.

a|`nbnAppointmentId`
a|The NBN identifier of the appointment.

a|`orderId`
a|The Order ID uniquely identifies an order that has been placed with NBN Co.

a|`appointmentFor`
a|ORDER \| SERVICE_PLAN_CHANGE. Indicates if the appointment is required due to an order or a service plan change.

a|`serviceId`
a|The ID of the 360 service.

a|`status`
a|The status of the appointment.

* `Reserved` - NBN Co allocates a unique Appointment ID when customer reserves an appointment, and the id must
be included in the order. Customer is awaiting appointment validation by NBN in this stage.

* `Booked`  - A `Reserved` Appointment will become a `Booked` Appointment if validated successfully by NBN Co.

* `In Progress` -  NBN Co is undertaking necessary fieldwork for the Appointment.

* `Complete` - The end stage of an Appointment that has completed.

* `Incomplete` - NBN Co notifies Customer that an Appointment could not commence and/or could not be completed as scheduled.

* `Cancelled` - Customer or NBN Co has cancelled an Appointment.

a|`startTime`
a|The date/time, including UTC offset, appointment start time will be visible only when appointment has been confirmed.

a|`endTime`
a|The date/time, including UTC offset, appointment end time, will be visible only when appointment has been confirmed.

a|`slotType`
a|The type of confirmed appointment slot. AM/ PM.

a|`timezoneOffset`
a| Represents an offset defined in a Timezone.

a|`priorityAssist`
a|Indicates whether the appointment is priority assisted or not.

a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.

a|`demandType`
a|The type of installation the appointment slot is provided for.

a|`contact`
a|The contact details of the appointment.

a|`contact.name`
a|The name of the contact.

a|`contact.type`
a|The type of the contact.

a|`contact.phone`
a|The number of the contact.

a|`contact.notes`
a|Additional information. If any.

a|`customerRef`
a|The reference string that you provided when you placed the order.
|===

==== Diagnostic Test Events
===== Diagnostic Test Accepted
:docinfo1:

The `DiagnosticTestAccepted` notification is sent when the diagnostic test has been accepted by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|diagnosticTest.accepted.event

|z-notification-type
|diagnosticTest.accepted.notification

|z-notification-model
|diagnosticTest
|===

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

.Example payload of the `DiagnosticTestAccepted` webhook notification

.Fields specific to DiagnosticTestAccepted
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`acceptedOn`
a|The date/time, including UTC offset, when the nbn accepted the diagnostic test.
|===

.Fields for all Diagnostic Test based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the diagnostic test.

a|`type`
a|The type of diagnostic test.

* Line State
* NTD-UNI-D status
* NTD status
* Port Reset
* DPU Port status
* NCD-UNI-D status
* DPU status
* NCD Reset
* NTD Reset

a|`status`
a|The status of the diagnostic test.

a|`requestedAt`
a|The date/time, including UTC offset, when the diagnostic test has been requested at.

a|`active`
a|Indicates whether the diagnostic test is in an active state.

a|`result`
a|The result of the diagnostic test. The test results varies depending on the type of test.

More details on the different test results can be found <<../common/diagnosticTest-result-by-type.adoc#,here>>.

a|`serviceId`
a|The ID of the 360 service.
|===

===== Diagnostic Test InProgress
:docinfo1:

The `DiagnosticTestInProgress` notification is sent when the diagnostic test has been started by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|diagnosticTest.inProgress.event

|z-notification-type
|diagnosticTest.inProgress.notification

|z-notification-model
|diagnosticTest
|===

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

.Example payload of the `DiagnosticTestInProgress` webhook notification

.Fields for all Diagnostic Test based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the diagnostic test.

a|`type`
a|The type of diagnostic test.

* Line State
* NTD-UNI-D status
* NTD status
* Port Reset
* DPU Port status
* NCD-UNI-D status
* DPU status
* NCD Reset
* NTD Reset

a|`status`
a|The status of the diagnostic test.

a|`requestedAt`
a|The date/time, including UTC offset, when the diagnostic test has been requested at.

a|`active`
a|Indicates whether the diagnostic test is in an active state.

a|`result`
a|The result of the diagnostic test. The test results varies depending on the type of test.

More details on the different test results can be found <<../common/diagnosticTest-result-by-type.adoc#,here>>.

a|`serviceId`
a|The ID of the 360 service.
|===

===== Diagnostic Test Completed
:docinfo1:

The `DiagnosticTestCompleted` notification is sent when the diagnostic test has been completed by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|diagnosticTest.completed.event

|z-notification-type
|diagnosticTest.completed.notification

|z-notification-model
|diagnosticTest
|===

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

.Example payload of the `DiagnosticTestCompleted` webhook notification

.Fields specific to DiagnosticTestCompleted
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`completedOn`
a|The date/time, including UTC offset, when the nbn completed the diagnostic test.
|===

.Fields for all Diagnostic Test based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the diagnostic test.

a|`type`
a|The type of diagnostic test.

* Line State
* NTD-UNI-D status
* NTD status
* Port Reset
* DPU Port status
* NCD-UNI-D status
* DPU status
* NCD Reset
* NTD Reset

a|`status`
a|The status of the diagnostic test.

a|`requestedAt`
a|The date/time, including UTC offset, when the diagnostic test has been requested at.

a|`active`
a|Indicates whether the diagnostic test is in an active state.

a|`result`
a|The result of the diagnostic test. The test results varies depending on the type of test.

More details on the different test results can be found <<../common/diagnosticTest-result-by-type.adoc#,here>>.

a|`serviceId`
a|The ID of the 360 service.
|===

===== Diagnostic Test Cancelled
:docinfo1:

The `DiagnosticTestCancelled` notification is sent when the diagnostic test has been cancelled by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|diagnosticTest.cancelled.event

|z-notification-type
|diagnosticTest.cancelled.notification

|z-notification-model
|diagnosticTest
|===

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

.Example payload of the `DiagnosticTestCancelled` webhook notification

.Fields specific to DiagnosticTestCancelled
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`cancelledOn`
a|The date/time, including UTC offset, when the nbn cancelled the diagnostic test.
|===

.Fields for all Diagnostic Test based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the diagnostic test.

a|`type`
a|The type of diagnostic test.

* Line State
* NTD-UNI-D status
* NTD status
* Port Reset
* DPU Port status
* NCD-UNI-D status
* DPU status
* NCD Reset
* NTD Reset

a|`status`
a|The status of the diagnostic test.

a|`requestedAt`
a|The date/time, including UTC offset, when the diagnostic test has been requested at.

a|`active`
a|Indicates whether the diagnostic test is in an active state.

a|`result`
a|The result of the diagnostic test. The test results varies depending on the type of test.

More details on the different test results can be found <<../common/diagnosticTest-result-by-type.adoc#,here>>.

a|`serviceId`
a|The ID of the 360 service.
|===

===== Diagnostic Test Rejected
:docinfo1:

The `DiagnosticTestRejected` notification is sent when the diagnostic test has been rejected by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|diagnosticTest.rejected.event

|z-notification-type
|diagnosticTest.rejected.notification

|z-notification-model
|diagnosticTest
|===

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

.Example payload of the `DiagnosticTestRejected` webhook notification

.Fields specific to DiagnosticTestRejected
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`rejectedOn`
a|The date/time, including UTC offset, when the nbn rejected the diagnostic test.
|===

.Fields for all Diagnostic Test based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the diagnostic test.

a|`type`
a|The type of diagnostic test.

* Line State
* NTD-UNI-D status
* NTD status
* Port Reset
* DPU Port status
* NCD-UNI-D status
* DPU status
* NCD Reset
* NTD Reset

a|`status`
a|The status of the diagnostic test.

a|`requestedAt`
a|The date/time, including UTC offset, when the diagnostic test has been requested at.

a|`active`
a|Indicates whether the diagnostic test is in an active state.

a|`result`
a|The result of the diagnostic test. The test results varies depending on the type of test.

More details on the different test results can be found <<../common/diagnosticTest-result-by-type.adoc#,here>>.

a|`serviceId`
a|The ID of the 360 service.
|===

===== Diagnostic Test Failed
:docinfo1:

The `DiagnosticTestFailed` notification is sent when the diagnostic test has been failed by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|diagnosticTest.failed.event

|z-notification-type
|diagnosticTest.failed.notification

|z-notification-model
|diagnosticTest
|===

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

.Example payload of the `DiagnosticTestFailed` webhook notification

.Fields specific to DiagnosticTestFailed
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`failedOn`
a|The date/time, including UTC offset, when the nbn failed the diagnostic test.
|===

.Fields for all Diagnostic Test based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`id`
a|The Connect identifier of the diagnostic test.

a|`type`
a|The type of diagnostic test.

* Line State
* NTD-UNI-D status
* NTD status
* Port Reset
* DPU Port status
* NCD-UNI-D status
* DPU status
* NCD Reset
* NTD Reset

a|`status`
a|The status of the diagnostic test.

a|`requestedAt`
a|The date/time, including UTC offset, when the diagnostic test has been requested at.

a|`active`
a|Indicates whether the diagnostic test is in an active state.

a|`result`
a|The result of the diagnostic test. The test results varies depending on the type of test.

More details on the different test results can be found <<../common/diagnosticTest-result-by-type.adoc#,here>>.

a|`serviceId`
a|The ID of the 360 service.
|===

==== Order Events

===== Order Accepted
:docinfo1:

The `OrderAccepted` notification is sent when an order you have placed has been accepted by the nbn and is going to be provisioned.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.accepted.event

|z-notification-type
|order.accepted.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderAccepted` webhook notification

.Fields specific to OrderAccepted
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`acceptedOn`
a|The date/time, including UTC offset, when the nbn accepted the order
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Order Acknowledged
:docinfo1:

The `OrderAcknowledged` notification is sent when an order you have placed has been acknowledged by the nbn.
"Acknowledging" means that the nbn system has received the order, but it needs to be validated before it can be accepted.
When the nbn accepts the order, the <<./order-accepted.adoc#,`OrderAccepted`>> webhook notification is sent.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.acknowledged.event

|z-notification-type
|order.acknowledged.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderAcknowledged` webhook notification

.Fields specific to OrderAcknowledged
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`acknowledgedOn`
a|The date/time, including UTC offset, when the nbn acknowledged the order
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===


.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===


===== Order Acknowledgement Failed
:docinfo1:

The `OrderAcknowledgementFailed` notification is sent when an order fails to be acknowledged by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.acknowledgement-failed.event

|z-notification-type
|order.acknowledgement-failed.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderAcknowledgementFailed` webhook notification

.Fields specific to OrderAcknowledgementFailed
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`failedOn`
a|The date/time, including UTC offset, when the nbn failed the order.

a|`failedReason`
a|The reason the order failed from nbn.
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===


===== Order Appointment Required
:docinfo1:

The `OrderAppointmentRequired` notification is sent when an order requires an appointment to be scheduled.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.appointment-required.event

|z-notification-type
|order.appointment-required.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderAppointmentRequired` webhook notification

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Order Cancelled
:docinfo1:

The `OrderCancelled` notification is sent when an order you have placed has been cancelled.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.cancelled.event

|z-notification-type
|order.cancelled.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderCancelled` webhook notification

.Fields specific to OrderCancelled
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`cancelledOn`
a|The date/time, including UTC offset, when the nbn cancelled the order
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Order Cancellation Error
:docinfo1:

The `OrderCancellationError` notification is sent when an order cancellation is rejected or NBN returns with an error.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.cancellation-error.event

|z-notification-type
|order.cancellation-error.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderCancellationError` webhook notification

.Fields specific to OrderCancellationError
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`cancellationFailedOn`
a|The date/time, including UTC offset, when the nbn cancellation error occurred

a|`cancellationFailedReason`
a|The reason for the cancellation error
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Order Failed Nbn Validation
:docinfo1:s

The `OrderFailedNbnValidation` notification is sent when an order you have placed, has failed validation done by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.failed-nbn-validation.event

|z-notification-type
|order.failed-nbn-validation.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderFailedNbnValidation` webhook notification

.Fields specific to OrderFailedNbnValidation
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`failedOn`
a|The date/time, including UTC offset, when the nbn failed the order.

a|`failedReason`
a|The reason the order failed from nbn.
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Order Nbn Action Completed
:docinfo1:

The `OrderNbnActionCompleted` notification is sent when an nbn action has been completed.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL include the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.nbn-action-completed.event

|z-notification-type
|order.nbn-action-completed.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderNbnActionCompleted` webhook notification

.Fields specific to OrderNbnActionCompleted
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`description`
a|The nbn action completed
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

=====  Order NbnAction Required
:docinfo1:

The `OrderNbnActionRequired` notification is sent when an nbn action is required before an order can be completed.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL include the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.nbn-action-required.event

|z-notification-type
|order.nbn-action-required.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderNbnActionRequired` webhook notification

.Fields specific to OrderNbnActionRequired
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`description`
a|The nbn action required
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Order Rejected
:docinfo1:

The `OrderRejected` notification is sent when an order you have placed has been rejected by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.rejected.event

|z-notification-type
|order.rejected.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderRejected` webhook notification

.Fields specific to OrderRejected
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`rejectedReason`
a|The reason to reject the order by nbn.

a|`rejectedOn`
a|The date/time, including UTC offset, when the nbn rejected the order.
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Order Shipment Awaiting Collection
:docinfo1:

The `OrderShipmentAwaitingCollection` notification is sent when the shipped NTD/NCD device has arrived the destination and is awaiting collection, likely from the local Post Office.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|order.shipment-awaiting-collection.event

|z-notification-type
|order.shipment-awaiting-collection.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderShipmentAwaitingCollection` webhook notification

.Fields specific to OrderShipmentAwaitingCollection
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`shippingStatus`
a|The status of the shipment.

a|`shippingReferenceNumber`
a|The tracking number assigned to the shipment.

a|`contactName`
a|The name of the person the NTD/NCD device is delivered to.

a|`contactNumber`
a|The contact number of the person the NTD/NCD device is delivered to.

a|`businessName`
a|The name of the business, if applicable.

a|`addressLine1`
a|The address where the NTD/NCD device is delivered to.

a|`addressLine2`
a|The address where the NTD/NCD device is delivered to, if applicable.

a|`suburb`
a|The suburb.

a|`postcode`
a|The postcode.

a|`state`
a|The state.

a|`deliveryInstructions`
a|Instructions to the delivery.

a|`authorityToLeave`
a|Permission to leave the NTD/NCD device at the delivery address without a signature.
|===


.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Order Shipment Delivered
:docinfo1:

The `OrderShipmentDelivered` notification is sent when the NTD/NCD device required for your order has been delivered.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.shipment-delivered.event

|z-notification-type
|order.shipment-delivered.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderShipmentDelivered` webhook notification

.Fields specific to OrderShipmentDelivered
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`shippingStatus`
a|The status of the shipment.

a|`shippingReferenceNumber`
a|The tracking number assigned to the shipment.

a|`contactName`
a|The name of the person the NTD/NCD device is delivered to.

a|`contactNumber`
a|The contact number of the person the NTD/NCD device is delivered to.

a|`businessName`
a|The name of the business, if applicable.

a|`addressLine1`
a|The address where the NTD/NCD device is delivered to.

a|`addressLine2`
a|The address where the NTD/NCD device is delivered to, if applicable.

a|`suburb`
a|The suburb.

a|`postcode`
a|The postcode.

a|`state`
a|The state.

a|`deliveryInstructions`
a|Instructions to the delivery.

a|`authorityToLeave`
a|Permission to leave the NTD/NCD device at the delivery address without a signature.
|===


.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===


===== Order Shipment InTransit
:docinfo1:

The `OrderShipmentInTransit` notification is sent when the NTD/NCD device required for your order has been shipped by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.shipment-in-transit.event

|z-notification-type
|order.shipment-in-transit.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderShipmentInTransit` webhook notification

.Fields specific to OrderShipmentInTransit
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`shippingStatus`
a|The status of the shipment.

a|`shippingReferenceNumber`
a|The tracking number assigned to the shipment.

a|`contactName`
a|The name of the person the NTD/NCD device is delivered to.

a|`contactNumber`
a|The contact number of the person the NTD/NCD device is delivered to.

a|`businessName`
a|The name of the business, if applicable.

a|`addressLine1`
a|The address where the NTD/NCD device is delivered to.

a|`addressLine2`
a|The address where the NTD/NCD device is delivered to, if applicable.

a|`suburb`
a|The suburb.

a|`postcode`
a|The postcode.

a|`state`
a|The state.

a|`deliveryInstructions`
a|Instructions to the delivery.

a|`authorityToLeave`
a|Permission to leave the NTD/NCD device at the delivery address without a signature.
|===


.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===


===== Order Awaiting Device Installation
:docinfo1:

The `OrderAwaitingDeviceInstallation` notification is sent when an nbn device has been shipped to site as part of a self install but has not been connected.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.awaiting-device-installation.event

|z-notification-type
|order.awaiting-device-installation.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderAwaitingDeviceInstallation` webhook notification

.Fields specific to OrderAwaitingDeviceInstallation
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`description`
a|Description of the notification
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

=====  Order Fttc Activate
:docinfo1:

The `OrderFttcActivate` notification is sent when the self installation kits are awaiting installation.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.fttc-activate.event

|z-notification-type
|order.fttc-activate.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderFttcActivate` webhook notification

.Fields specific to OrderFttcActivate
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`informationRequired`
a| Information is required or not

a|`informationRequiredReason`
a|The reason why information is required
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Order Hfc Ntd Not On line
:docinfo1:

The `OrderHfcNtdNotOnline` notification is sent when a HFC order NTD is not online.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.hfc-ntd-not-online.event

|z-notification-type
|order.hfc-ntd-not-online.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderHfcNtdNotOnline` webhook notification

.Fields specific to OrderHfcNtdNotOnline
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`description`
a|Details about the offline hfc ntd
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Order Aggregation Completed
:docinfo1:

The `OrderAggregationCompleted` notification is sent when the requested order has been activated on Superloop’s network.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|order.aggregation-completed.event

|z-notification-type
|order.aggregation-completed.notification

|z-notification-model
|order
|===

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service's configuration.

.Example payload of the `OrderAggregationCompleted` webhook notification

.Fields specific to OrderAggregationCompleted
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`acceptedOn`
a|The date/time, including UTC offset, when the nbn accepted the order
a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`
a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`
|===

.Fields for all Order based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the order is for a new service or a transfer.

* `new` - when placing an order for the first infrastructure or an additional infrastructure
* `transfer` -  when placing an order for an in use infrastructure

a|`serviceClass`
a|The standard nbn service class of the site.

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`installationType`
a|Whether the NTD is going to be installed by an nbn technician or by the site's tenant.

* `nbn-tech` - an nbn technician is going to install the NTD
* `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it
* `nbn-no-action` - The is no need for a new NTD to be installed

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate
and OrderHfcNtdNotOnline notifications.

a|`avcIdForTransfer`
a|The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or
NCD (Copper Pair) with a Line In Use. Null in all other cases.

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site will be serviced from

a|`poiName`
a|The name of the nbn POI that the site will be serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service will have. Currently, only `Standard` is available.


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable.

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service.Only for NTD infrastructure.

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer.

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`serviceId`
a|The ID of the 360 service that the order fulfils

a|`id`
a|The ID of the 360 order

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`isNfas`
a|Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`isCancellable`
a|Indicates whether the order is cancellable. Possible values are:

* `true`
* `false`

a|`transferType`
a|Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are:

* `SERVICE_TRANSFER`
* `CONNECT_OUTSTANDING`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

==== Service Events

===== Service Activated
:docinfo1:

The `ServiceActivated` notification is sent when the requested service has been activated by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|service.activated.event

|z-notification-type
|service.activated.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 that the service is provided.

.Example payload of the `ServiceActivated` webhook notification

.Example payload of the `ServiceActivated` webhook notification when the service is an nbn Co's Fibre Access Service (NFAS).

.Fields for all Service webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

.Fibre Upgrade Early Termination Fee Applicable plans
[cols="1, 3",options=header]
|===
|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
|===

===== Service Aggregation Modified
:docinfo1:

The `ServiceAggregationModified` notification is sent after the service has successfully been converted to new aggregation method.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|service.aggregation-modified.event

|z-notification-type
|service.aggregation-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 `ServiceAggregationModified` webhook notification

.Fields specific to ServiceAggregationModified
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`modifiedOn`
a|The date/time, including UTC offset, when the service aggregation was modified.
|===


.Fields for all Service based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

.Fibre Upgrade Early Termination Fee Applicable plans
[cols="1, 3",options=header]
|===
|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
|===

===== Service Aggregation Modification Failed
:docinfo1:

The `ServiceAggregationModificationFailed` notification is sent when the service could not be converted to the new aggregation method.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|service.aggregation-modification-failed.event

|z-notification-type
|service.aggregation-modification-failed.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 `ServiceAggregationModificationFailed` webhook notification

.Fields specific to ServiceAggregationModificationFailed
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`rejectedReason`
a|The reason the service aggregation modification could not be completed.
|===


.Fields for all Service based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

.Fibre Upgrade Early Termination Fee Applicable plans
[cols="1, 3",options=header]
|===
|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
|===

===== Service Cancelled
:docinfo1:

The `ServiceCancelled` notification is sent when the service has been cancelled by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|service.cancelled.event

|z-notification-type
|service.cancelled.notification

|z-notification-model
|service
|===
The payload of the notification will include the configuration of the service that you ordered as well as the ID of the 360 service.

.Example payload of the `ServiceCancelled` webhook notification

.Fields specific to ServiceCancelled
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`cancelledOn`
a|The date/time, including UTC offset, when the nbn cancelled the service

a|`cancelledBy`
a| The name of the provider who cancelled the service. Possible values are:

* `Superloop`
* `Third Party`

|===

.Fields for all Service webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

.Fibre Upgrade Early Termination Fee Applicable plans
[cols="1, 3",options=header]
|===
|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
|===

===== Service Cancellation Rejected
:docinfo1:

The `ServiceCancellationRejected` notification is sent when the service cancellation request has been rejected by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|service.cancellation-rejected.event

|z-notification-type
|service.cancellation-rejected.notification

|z-notification-model
|service
|===
The payload of the notification will include the configuration of the service that you ordered as well as the ID of the 360 service.

.Example payload of the `ServiceCancellationRejected` webhook notification

.Fields specific to ServiceCancelled
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`rejectedReason`
a|The reason nbn has rejected the service cancellation request
|===


.Fields for all Service webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

.Fibre Upgrade Early Termination Fee Applicable plans
[cols="1, 3",options=header]
|===
|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
|===

===== Service Modification Rejected
:docinfo1:

The `ServiceModificationRejected` notification is sent when a service modification has been failed in the nbn.

*Note*: Sending `ServiceModificationRejected` 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 <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|service.modification-rejected.event

|z-notification-type
|service.modification-rejected.notification

|z-notification-model
|service
|===


The payload of the notification will include the configuration of the service as well as a reason the request was rejected.

.Example payload of the `ServiceModificationRejected` webhook notification

.Fields specific to ServiceModificationRejected
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`rejectedReason`
a|The reason the service modification has failed in the nbn.
|===


.Fields for all Service based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

.Fibre Upgrade Early Termination Fee Applicable plans
[cols="1, 3",options=header]
|===
|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
|===

===== Service Modified
:docinfo1:

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 <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|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`

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

.Fields specific to ServiceModified
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`modifiedOn`
a|The date/time, including UTC offset, when the service has been modified.
|===

.Fields for all Service based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

.Fibre Upgrade Early Termination Fee Applicable plans
[cols="1, 3",options=header]
|===
|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
|===

===== Service Reclaim Activated
:docinfo1:

The `ServiceReclaimActivated` notification is sent when the requested service reclaim has been re-activated by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|service.reclaim-activated.event

|z-notification-type
|service.reclaim-activated.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 that the service is provided.

.Example payload of the `ServiceReclaimActivated` webhook notification

.Fields for all Service webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

.Fibre Upgrade Early Termination Fee Applicable plans
[cols="1, 3",options=header]
|===
|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
|===

===== Service Reclaim Failed
:docinfo1:

The `ServiceReclaimFailed` notification is sent when the requested service reclaim has been rejected by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|service.reclaim-failed.event

|z-notification-type
|service.reclaim-failed.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 `ServiceReclaimFailed` webhook notification

.Fields specific to ServiceReclaimFailed
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`failedReason`
a|The reason nbn has rejected the service reclaim request
|===

.Fields for all Service webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

.Fibre Upgrade Early Termination Fee Applicable plans
[cols="1, 3",options=header]
|===
|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
|===

===== Service PlanChanged
:docinfo1:

The `ServicePlanChanged` notification is sent when a service plan change you have requested has been accepted by
the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|service.plan-changed.event

|z-notification-type
|service.plan-changed.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 `ServicePlanChanged` webhook notification where Aggregation Method is `L2TP`

.Example payload of the `ServicePlanChanged` webhook notification where Aggregation Method is `ETHERNET`

.Fields specific to ServicePlanChanged
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`modifiedOn`
a|The date/time, including UTC offset, when the service has been modified.
|===


.Fields for all Service based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Service PlanChange Rejected
:docinfo1:

The `ServicePlanChangeRejected` notification is sent when a service plan change you have requested has been rejected by
the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|service.plan-change-rejected.event

|z-notification-type
|service.plan-change-rejected.notification

|z-notification-model
|service
|===


The payload of the notification will include the configuration of the service as well as a reason the request was rejected.

.Example payload of the `ServicePlanChangeRejected` webhook notification

.Fields specific to ServicePlanChangeRejected
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`rejectedReason`
a|The reason nbn has rejected the service plan change modification
|===


.Fields for all Service based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Service RestorationSla Changed
:docinfo1:

The `ServiceRestorationSlaChanged` notification is sent when a service restoration SLA change you have requested has been accepted by
the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|service.restoration-sla-changed.event

|z-notification-type
|service.restoration-sla-changed.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 `ServiceRestorationSlaChanged` webhook notification where Aggregation Method is `L2TP`

.Example payload of the `ServiceRestorationSlaChanged` webhook notification where Aggregation Method is `ETHERNET`

.Fields specific to ServiceRestorationSlaChanged
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`modifiedOn`
a|The date/time, including UTC offset, when the service has been modified.
|===


.Fields for all Service based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Service RestorationSlaChange Rejected
:docinfo1:

The `ServiceRestorationSlaChangeRejected` notification is sent when a service restoration sla change you have requested has been rejected by
the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|service.restoration-sla-change-rejected.event

|z-notification-type
|service.restoration-sla-change-rejected.notification

|z-notification-model
|service
|===


The payload of the notification will include the configuration of the service as well as a reason the request was rejected.

.Example payload of the `ServiceRestorationSlaChangeRejected` webhook notification

.Fields specific to ServiceRestorationSlaChangeRejected
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`rejectedReason`
a|The reason nbn has rejected the service restoration sla change modification
|===


.Fields for all Service based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Service DslStabilityProfile Changed
:docinfo1:

The `ServiceDslStabilityProfileChanged ` notification is sent after the service has successfully changed to the requested DSL stability profile.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|service.dsl-stability-profile-changed.event

|z-notification-type
|service.dsl-stability-profile-changed.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 `ServiceDslStabilityProfileChanged ` webhook notification

.Fields specific to ServiceDslStabilityProfileChanged
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`modifiedOn`
a|The date/time, including UTC offset, when the service DSL stability profile change was modified.
|===


.Fields for all Service based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

===== Service DslStabilityProfileChange Rejected
:docinfo1:

The `ServiceDslStabilityProfileChangeRejected` notification is sent when the service could not be modified to the new stability profile.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|service.dsl-stability-profile-change-rejected.event

|z-notification-type
|service.dsl-stability-profile-change-rejected.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 `ServiceDslStabilityProfileChangeRejected` webhook notification

.Fields specific to ServiceDslStabilityProfileChangeRejected
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`rejectedReason`
a|The reason the service DSL stability profile change modification could not be completed.
|===


.Fields for all Service based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`customerRef`
a|The reference string that you provided when you placed the order

a|`nbnServiceActivatedOn`
a|The date the nbn enabled the service on their end

a|`technologyType`
a|The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below

a|`trafficClass`
a|The nbn traffic class, e.g. `TC4`

a|`locId`
a|The nbn LOC ID of the address of the site the order is for

a|`avcId`
a|The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site

a|`vlanId`
a|The VLAN that was specified at order time

a|`poi`
a|The code of the nbn POI that the site is serviced from

a|`region`
a|The nbn region identifier that nbn places the site in. Possible values are:

* `Major Rural`
* `Minor Rural`
* `Remote`
* `Urban`
* `Isolated Area`
* `Limited Access Area`


a|`eSla`
a|The level of restoration SLA that the service has


a|`bandwidthProfile`
a|An object that contains details on the bandwidth profile that was selected for the service

a|`bandwidthProfile.speedDown`
a|The download speed of the service, in mbps

a|`bandwidthProfile.speedUp`
a|The upload speed of the service, in mbps

a|`bandwidthProfile.planName`
a|The name of the plan that was selected for the service

a|`bandwidthProfile.cvcInclusion`
a|The CVC inclusion that is applied to CVC rebates, if applicable

a|`infrastructure`
a|Information about the infrastructure at the site, including NTDs and Copper Pairs

a|`infrastructure.id`
a|The nbn identifier of the equipment

a|`infrastructure.portId`
a|The port on the device that was chosen for the service. Only for NTD infrastructure

a|`infrastructure.productId`
a|The nbn identifier of the product component that is activated for the Customer

a|`address`
a|The address of the site where the service is being provided

a|`address.buildingLevel`
a|The level that the site is on, if applicable

a|`address.unitNumber`
a|The unit number of the site, if applicable

a|`address.buildingName`
a|The name of the building, if applicable

a|`address.streetNumber`
a|The street number of the site

a|`address.street`
a|The name of the street, including street type

a|`address.suburb`
a|The suburb

a|`address.state`
a|The state

a|`address.postcode`
a|The postcode

a|`address.formattedAddress`
a|The whole address, formatted in a single line

a|`id`
a|The ID of the 360 service that the order fulfils

a|`aggregationMethod`
a|The aggregation method of the order. Possible values are:

* `L2TP`
* `ETHERNET`

a|`subscriberSTag`
a|The subscriber S-Tag. Only set when aggregationMethod is `ETHERNET`

a|`subscriberCTag`
a|The subscriber C-Tag. Only set when aggregationMethod is `ETHERNET`

a|`isNfas`
a|Indicates whether the service is a nbn Co's Fibre Access Service (NFAS). Possible values are:

* `true`
* `false`

a|`hasNfasCommitment`
a|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.

a|`nfasCommitmentExpiresOn`
a|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)

a|`legacyTechnologyType`
a|Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

a|`dslStabilityProfile`
a|The DSL stability profile of the service. Only set for copper services FTTB and FTTN . Possible values are:

* `Standard`
* `Stable`

|===

.nbn Technology Type Map
[cols="1, 3",options=header]
|===
|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
|===

==== Disruption Events

===== Scheduled Maintenance Created
:docinfo1:

The `ScheduledMaintenanceCreated` notification is sent when a maintenance affecting your service is created.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.scheduled-maintenance-created.event

|z-notification-type
|disruption.scheduled-maintenance-created.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the maintenance affecting your service.

.Example payload of the `ScheduledMaintenanceCreated` webhook notification

.Fields specific to ScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Scheduled Maintenance Started
:docinfo1:

The `ScheduledMaintenanceStarted` notification is sent when a maintenance affecting your service is started.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.scheduled-maintenance-started.event

|z-notification-type
|disruption.scheduled-maintenance-started.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the maintenance affecting your service.

.Example payload of the `ScheduledMaintenanceStarted` webhook notification

.Fields specific to ScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Scheduled Maintenance Held
:docinfo1:

The `ScheduledMaintenanceHeld` notification is sent when a maintenance affecting your service is held.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.scheduled-maintenance-held.event

|z-notification-type
|disruption.scheduled-maintenance-held.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the maintenance affecting your service.

.Example payload of the `ScheduledMaintenanceHeld` webhook notification

.Fields specific to ScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Scheduled Maintenance Additional Work Started
:docinfo1:

The `ScheduledMaintenanceAdditionalWorkStarted` notification is sent when a maintenance affecting your service has started additional work.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.scheduled-maintenance-additional-work-started.event

|z-notification-type
|disruption.scheduled-maintenance-additional-work-started.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the maintenance affecting your service.

.Example payload of the `ScheduledMaintenanceAdditionalWorkStarted` webhook notification

.Fields specific to ScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===


.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Scheduled Maintenance Cancelled
:docinfo1:

The `ScheduledMaintenanceCancelled` notification is sent when a maintenance affecting your service is cancelled.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.scheduled-maintenance-cancelled.event

|z-notification-type
|disruption.scheduled-maintenance-cancelled.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the maintenance affecting your service.

.Example payload of the `ScheduledMaintenanceCancelled` webhook notification

.Fields specific to ScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Schedule Maintenance Completed
:docinfo1:

The `ScheduledMaintenanceCompleted` notification is sent when a maintenance affecting your service is completed.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.scheduled-maintenance-completed.event

|z-notification-type
|disruption.scheduled-maintenance-completed.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the maintenance affecting your service.

.Example payload of the `ScheduledMaintenanceCompleted` webhook notification

.Fields specific to ScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Scheduled Maintenance Updated
:docinfo1:

The `ScheduledMaintenanceUpdated` notification is sent when a maintenance affecting your service is updated.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.scheduled-maintenance-updated.event

|z-notification-type
|disruption.scheduled-maintenance-updated.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the maintenance affecting your service.

.Example payload of the `ScheduledMaintenanceUpdated` webhook notification

.Fields specific to ScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Unscheduled Incident Created
:docinfo1:

The `UnscheduledIncidentCreated` notification is sent when an unscheduled incident affecting your service is created.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.unscheduled-incident-created.event

|z-notification-type
|disruption.unscheduled-incident-created.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the incident affecting your service.

.Example payload of the `UnscheduledIncidentCreated` webhook notification

.Fields specific to UnscheduledIncident
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`worklogs`
a|List of worklogs for the incident.

a|`worklogs.nbnId`
a|The nbn ID of the  worklog.

a|`worklogs.note`
a|The note about the worklog.

a|`worklogs.providedBy`
a|Who provided the work.

a|`worklogs.providedAt`
a|The date/time, including UTC offset, when the nbn work was provided.

a|`worklogs.type`
a|The type of the worklog.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Unscheduled Incident Updated
:docinfo1:

The `UnscheduledIncidentUpdated` notification is sent when an unscheduled incident affecting your service is updated.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.unscheduled-incident-updated.event

|z-notification-type
|disruption.unscheduled-incident-updated.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the incident affecting your service.

.Example payload of the `UnscheduledIncidentUpdated` webhook notification

.Fields specific to UnscheduledIncident
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`worklogs`
a|List of worklogs for the incident.

a|`worklogs.nbnId`
a|The nbn ID of the  worklog.

a|`worklogs.note`
a|The note about the worklog.

a|`worklogs.providedBy`
a|Who provided the work.

a|`worklogs.providedAt`
a|The date/time, including UTC offset, when the nbn work was provided.

a|`worklogs.type`
a|The type of the worklog.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Unscheduled Incident Resolved
:docinfo1:

The `UnscheduledIncidentResolved` notification is sent when an unscheduled incident affecting your service is resolved.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.unscheduled-incident-resolved.event

|z-notification-type
|disruption.unscheduled-incident-resolved.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the incident affecting your service.

.Example payload of the `UnscheduledIncidentResolved` webhook notification

.Fields specific to UnscheduledIncident
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`worklogs`
a|List of worklogs for the incident.

a|`worklogs.nbnId`
a|The nbn ID of the  worklog.

a|`worklogs.note`
a|The note about the worklog.

a|`worklogs.providedBy`
a|Who provided the work.

a|`worklogs.providedAt`
a|The date/time, including UTC offset, when the nbn work was provided.

a|`worklogs.type`
a|The type of the worklog.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Unscheduled Incident Closed
:docinfo1:

The `UnscheduledIncidentClosed` notification is sent when an unscheduled incident affecting your service is closed.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.unscheduled-incident-closed.event

|z-notification-type
|disruption.unscheduled-incident-closed.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the incident affecting your service.

.Example payload of the `UnscheduledIncidentClosed` webhook notification

.Fields specific to UnscheduledIncident
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`worklogs`
a|List of worklogs for the incident.

a|`worklogs.nbnId`
a|The nbn ID of the  worklog.

a|`worklogs.note`
a|The note about the worklog.

a|`worklogs.providedBy`
a|Who provided the work.

a|`worklogs.providedAt`
a|The date/time, including UTC offset, when the nbn work was provided.

a|`worklogs.type`
a|The type of the worklog.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

===== Unscheduled Incident Cancelled
:docinfo1:

The `UnscheduledIncidentCancelled` notification is sent when an unscheduled incident affecting your service is cancelled.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|disruption.unscheduled-incident-cancelled.event

|z-notification-type
|disruption.unscheduled-incident-cancelled.notification

|z-notification-model
|disruption
|===


The payload of the notification will include the details of the incident affecting your service.

.Example payload of the `UnscheduledIncidentCancelled` webhook notification

.Fields specific to UnscheduledIncident
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`worklogs`
a|List of worklogs for the incident.

a|`worklogs.nbnId`
a|The nbn ID of the  worklog.

a|`worklogs.note`
a|The note about the worklog.

a|`worklogs.providedBy`
a|Who provided the work.

a|`worklogs.providedAt`
a|The date/time, including UTC offset, when the nbn work was provided.

a|`worklogs.type`
a|The type of the worklog.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceId`
a|The ID of the 360 service that the maintenance occurs on.

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

|===

==== Aggregated Disruption Events

===== Aggregated Scheduled Maintenance Created
:docinfo1:

The `AggregatedScheduledMaintenanceCreated` notification is sent when a maintenance affecting at least one of your services is created.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.scheduled-maintenance-created.event

|z-notification-type
|aggregatedDisruption.scheduled-maintenance-created.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the maintenance affecting your services.

.Example payload of the `AggregatedScheduledMaintenanceCreated` webhook notification

.Fields specific to AggregatedScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Scheduled Maintenance Started
:docinfo1:

The `AggregatedScheduledMaintenanceStarted` notification is sent when a maintenance affecting at least one of your services is started.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.scheduled-maintenance-started.event

|z-notification-type
|aggregatedDisruption.scheduled-maintenance-started.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the maintenance affecting your services.

.Example payload of the `AggregatedScheduledMaintenanceStarted` webhook notification

.Fields specific to AggregatedScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Scheduled Maintenance Held
:docinfo1:

The `AggregatedScheduledMaintenanceHeld` notification is sent when a maintenance affecting at least one of your services is held.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.scheduled-maintenance-held.event

|z-notification-type
|aggregatedDisruption.scheduled-maintenance-held.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the maintenance affecting your services.

.Example payload of the `AggregatedScheduledMaintenanceHeld` webhook notification

.Fields specific to AggregatedScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Scheduled Maintenance Additional Work Started
:docinfo1:

The `AggregatedScheduledMaintenanceAdditionalWorkStarted` notification is sent when a maintenance affecting at least one of your services has started additional work.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.scheduled-maintenance-additional-work-started.event

|z-notification-type
|aggregatedDisruption.scheduled-maintenance-additional-work-started.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the maintenance affecting your services.

.Example payload of the `AggregatedScheduledMaintenanceAdditionalWorkStarted` webhook notification

.Fields specific to AggregatedScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===


.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Scheduled Maintenance Cancelled
:docinfo1:

The `AggregatedScheduledMaintenanceCancelled` notification is sent when a maintenance affecting at least one of your services is cancelled.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.scheduled-maintenance-cancelled.event

|z-notification-type
|aggregatedDisruption.scheduled-maintenance-cancelled.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the maintenance affecting your services.

.Example payload of the `AggregatedScheduledMaintenanceCancelled` webhook notification

.Fields specific to AggregatedScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Schedule Maintenance Completed
:docinfo1:

The `AggregatedScheduledMaintenanceCompleted` notification is sent when a maintenance affecting at least one of your services is completed.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.scheduled-maintenance-completed.event

|z-notification-type
|aggregatedDisruption.scheduled-maintenance-completed.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the maintenance affecting your services.

.Example payload of the `AggregatedScheduledMaintenanceCompleted` webhook notification

.Fields specific to AggregatedScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Scheduled Maintenance Updated
:docinfo1:

The `AggregatedScheduledMaintenanceUpdated` notification is sent when a maintenance affecting at least one of your services is updated.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.scheduled-maintenance-updated.event

|z-notification-type
|aggregatedDisruption.scheduled-maintenance-updated.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the maintenance affecting your services.

.Example payload of the `AggregatedScheduledMaintenanceUpdated` webhook notification

.Fields specific to AggregatedScheduledMaintenance
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`interruptions`
a|List of interruptions for the maintenance.

a|`interruptions.id`
a|The ID of the  interruption.

a|`interruptions.minutes`
a|The number of minutes of the interruption.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Unscheduled Incident Created
:docinfo1:

The `AggregatedUnscheduledIncidentCreated` notification is sent when an unscheduled incident affecting at least one of your services is created.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.unscheduled-incident-created.event

|z-notification-type
|aggregatedDisruption.unscheduled-incident-created.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the incident affecting your services.

.Example payload of the `AggregatedUnscheduledIncidentCreated` webhook notification

.Fields specific to AggregatedUnscheduledIncident
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`worklogs`
a|List of worklogs for the incident.

a|`worklogs.nbnId`
a|The nbn ID of the  worklog.

a|`worklogs.note`
a|The note about the worklog.

a|`worklogs.providedBy`
a|Who provided the work.

a|`worklogs.providedAt`
a|The date/time, including UTC offset, when the nbn work was provided.

a|`worklogs.type`
a|The type of the worklog.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Unscheduled Incident Updated
:docinfo1:

The `AggregatedUnscheduledIncidentUpdated` notification is sent when an unscheduled incident affecting at least one of your services is updated.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.unscheduled-incident-updated.event

|z-notification-type
|aggregatedDisruption.unscheduled-incident-updated.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the incident affecting your services.

.Example payload of the `AggregatedUnscheduledIncidentUpdated` webhook notification

.Fields specific to AggregatedUnscheduledIncident
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`worklogs`
a|List of worklogs for the incident.

a|`worklogs.nbnId`
a|The nbn ID of the  worklog.

a|`worklogs.note`
a|The note about the worklog.

a|`worklogs.providedBy`
a|Who provided the work.

a|`worklogs.providedAt`
a|The date/time, including UTC offset, when the nbn work was provided.

a|`worklogs.type`
a|The type of the worklog.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Unscheduled Incident Resolved
:docinfo1:

The `AggregatedUnscheduledIncidentResolved` notification is sent when an unscheduled incident affecting at least one of your services is resolved.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.unscheduled-incident-resolved.event

|z-notification-type
|aggregatedDisruption.unscheduled-incident-resolved.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the incident affecting your services.

.Example payload of the `AggregatedUnscheduledIncidentResolved` webhook notification

.Fields specific to AggregatedUnscheduledIncident
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`worklogs`
a|List of worklogs for the incident.

a|`worklogs.nbnId`
a|The nbn ID of the  worklog.

a|`worklogs.note`
a|The note about the worklog.

a|`worklogs.providedBy`
a|Who provided the work.

a|`worklogs.providedAt`
a|The date/time, including UTC offset, when the nbn work was provided.

a|`worklogs.type`
a|The type of the worklog.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Unscheduled Incident Closed
:docinfo1:

The `AggregatedUnscheduledIncidentClosed` notification is sent when an unscheduled incident affecting at least one of your services is closed.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.unscheduled-incident-closed.event

|z-notification-type
|aggregatedDisruption.unscheduled-incident-closed.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the incident affecting your services.

.Example payload of the `AggregatedUnscheduledIncidentClosed` webhook notification

.Fields specific to AggregatedUnscheduledIncident
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`worklogs`
a|List of worklogs for the incident.

a|`worklogs.nbnId`
a|The nbn ID of the  worklog.

a|`worklogs.note`
a|The note about the worklog.

a|`worklogs.providedBy`
a|Who provided the work.

a|`worklogs.providedAt`
a|The date/time, including UTC offset, when the nbn work was provided.

a|`worklogs.type`
a|The type of the worklog.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

===== Aggregated Unscheduled Incident Cancelled
:docinfo1:

The `AggregatedUnscheduledIncidentCancelled` notification is sent when an unscheduled incident affecting at least one of your services is cancelled.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, the request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header
|Value

|z-event-type
|aggregatedDisruption.unscheduled-incident-cancelled.event

|z-notification-type
|aggregatedDisruption.unscheduled-incident-cancelled.notification

|z-notification-model
|aggregatedDisruption
|===


The payload of the notification will include the details of the incident affecting your services.

.Example payload of the `AggregatedUnscheduledIncidentCancelled` webhook notification

.Fields specific to UnscheduledIncident
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`worklogs`
a|List of worklogs for the incident.

a|`worklogs.nbnId`
a|The nbn ID of the  worklog.

a|`worklogs.note`
a|The note about the worklog.

a|`worklogs.providedBy`
a|Who provided the work.

a|`worklogs.providedAt`
a|The date/time, including UTC offset, when the nbn work was provided.

a|`worklogs.type`
a|The type of the worklog.
|===

.Fields Disruption webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`type`
a|Whether the maintenance is scheduled or unscheduled.

a|`maintenanceStartAt`
a|The date/time, including UTC offset, when the nbn maintenance starts at.

a|`maintenanceEndAt`
a|The date/time, including UTC offset, when the nbn maintenance ends at.

a|`nbnDisruptionId`
a|The nbn ID of the maintenance.

a|`description`
a|Description of the maintenance.

a|`severity`
a|The severity of the maintenance.

a|`category`
a|The category of the maintenance.

a|`serviceIds`
a|List of 360 services that the maintenance occurs on.

|===

==== Service Health Events
===== Service Health Accepted
:docinfo1:

The `ServiceHealthAccepted` notification is sent when the service health request has been accepted by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|serviceHealth.accepted.event

|z-notification-type
|serviceHealth.accepted.notification

|z-notification-model
|serviceHealth
|===

The payload of the notification will include the service health request id.

.Example payload of the `ServiceHealthAccepted` webhook notification

.Fields for all Service Health based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceHealthRequestId`
a|The Connect identifier of the service health request.
|===

===== Service Health Completed
:docinfo1:

The `ServiceHealthCompleted` notification is sent when the service health request has been completed by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|serviceHealth.completed.event

|z-notification-type
|serviceHealth.completed.notification

|z-notification-model
|serviceHealth
|===

The payload of the notification will include the service health request id.

.Example payload of the `ServiceHealthCompleted` webhook notification

.Fields for all Service Health based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceHealthRequestId`
a|The Connect identifier of the service health request.
|===

===== Service Health Failed
:docinfo1:

The `ServiceHealthFailed` notification is sent when the service health request has been rejected by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|serviceHealth.failed.event

|z-notification-type
|serviceHealth.failed.notification

|z-notification-model
|serviceHealth
|===

The payload of the notification will include the service health request id.

.Example payload of the `ServiceHealthFailed` webhook notification

.Fields for all Service Health based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`serviceHealthRequestId`
a|The Connect identifier of the service health request.
|===

==== Service Location Coat Events
===== Location Coat Completed
:docinfo1:

The `LocationCoatCompleted` notification is sent when the service location coat request has been completed by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|locationCoat.completed.event

|z-notification-type
|locationCoat.completed.notification

|z-notification-model
|locationCoat
|===

The payload of the notification will include the service location coat details.

.Example payload of the `LocationCoatCompleted` webhook notification

.Fields specific to  Service Location Coat Completed webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`locationId`
a|The nbn unique identifier of the location.

a|`currentTechnology`
a|Current Primary Access Technology for the location.

a|`plannedTechnology`
a|The new Primary Access Technology that the location will move to.

a|`reason`
a|The reason for technology change.

a|`earliestChangeoverDate`
a|This is the earliest date when nbn plan to make the change to new technology. Format as yyyy-mm-dd.

a|`latestChangeoverDate`
a|This is the latest date when nbn plan to make the change to new technology. Format as yyyy-mm-dd.

a|`completedDate`
a|This is the date at which the old technology at the location will be decommissioned. Format as yyyy-mm-dd.

a|`coatsDataAsAt`
a|The date/time, including UTC offset, when location coat was last updated.

a|`reason`
a|The reason for technology change.

a|`formattedAddress`
a|The whole address of the location.
|===

==== Enterprise Ethernet Quotes Events
===== Fibre Build Charge Quote Completed
:docinfo1:

The `FibreBuildChargeQuoteCompleted` notification is sent when the fibre build charge quote has been completed by the nbn.

Along with the headers listed on the <<./index.adoc#_webhooks,main Superloop Connect page>>, The request headers that are sent with the request to the callback URL includes the following:

.Webhook Event Notification Request Headers
[cols="2, 3",options="header"]
|===
|Header|Value

|z-event-type
|fibreBuildChargeQuote.completed.event

|z-notification-type
|fibreBuildChargeQuote.completed.notification

|z-notification-model
|fibreBuildChargeQuote
|===

The payload of the notification will include the fibreBuildChargeQuoteCompleted details.

.Example payload of the `FibreBuildChargeQuoteCompleted` webhook notification

.Fields for all Quotes based webhooks
[cols="1, 2",options=header]
|===
|Field
|Explanation

a|`nbnLocationId`
a|The nbn unique identifier of the location.

a|`nbnQuoteId`
a|The nbn FBC quote Id.

a|`quoteDate`
a|The nbn FBC quote created date.

a|`zone`
a|The name of the nbn zone that the site will be serviced from.

a|`poiName`
a|The name of the nbn POI that the site will be serviced from.

a|`estDeliveryTime`
a|Estimated service delivery time.

a|`fibreBuildCategory`
a|The fibre build category.

a|`priceType`
a|Fibre Build Charge price type.

a|`name`
a|Fibre Build Charge.

a|`priceUnit`
a|Fibre Build Charge price currency unit.

a|`priceValue`
a|Fibre Build Charge cost in cents.

a|`validUntil`
a|The date till FBC quote valid.

a|`createdOn`
a|The date/time, including UTC offset, when FBC quote was created.


|===