Untitled

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

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

Table 1. Webhook Event Notification Request Headers
Header	Value
z-event-type	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

{
  "orderId": 10,
  "id": 583,
  "nbnAppointmentId": "APT190000000000",
  "status": "cancelled",
  "startTime": "2020-08-20T03:00:00Z",
  "endTime": "2020-08-20T07:00:00Z",
  "slotType": "PM",
  "timezoneOffset": "+10:00",
  "priorityAssist": false,
  "eSla": "Standard",
  "demandType": "Standard Install",
  "contact": {
    "name": "Lynette Santa",
    "type": "Primary Contact",
    "phone": "0739076000",
    "notes": null
  },
  "customerRef": "CUST-REF-007",
  "cancelledOn": "2020-08-14T06:06:33Z",
  "serviceId": 300
}

Table 2. Fields specific to AppointmentCancelled
Field	Explanation
`cancelledOn`	The date/time, including UTC offset, when the nbn cancelled the appointment.

Table 3. Fields for all Appointment based webhooks
Field	Explanation
`orderId`	The Order ID uniquely identifies an order that has been placed with NBN Co.
`id`	The Connect identifier of the appointment.
`nbnAppointmentId`	The NBN identifier of the appointment.
`status`	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.
`startTime`	The date/time, including UTC offset, appointment start time will be visible only when appointment has been confirmed.
`endTime`	The date/time, including UTC offset, appointment end time, will be visible only when appointment has been confirmed.
`slotType`	The type of confirmed appointment slot. AM/ PM.
`timezoneOffset`	Represents an offset defined in a Timezone.
`priorityAssist`	Indicates whether the appointment is priority assisted or not.
`eSla`	The level of restoration SLA that the service will have. Currently, only `Standard` is available.
`demandType`	The type of installation the appointment slot is provided for.
`contact`	The contact details of the appointment.
`contact.name`	The name of the contact.
`contact.type`	The type of the contact.
`contact.phone`	The number of the contact.
`contact.notes`	Additional information. If any.
`customerRef`	The reference string that you provided when you placed the order.
`serviceId`	The ID of the 360 service.