logo
API docs by Redocly

SPG Notifications (v1.2.8)

Download OpenAPI specification:Download

E-mail: api@tuatahifibre.co.nz

This interface should be implemented by Service Partners (aka SP, aka Work Suppliers) who want to receive notifications from the TFF Service Partner Gateway (SPG).

In order to start receiving SPG notifications, Service Partner must subscribe to the WorkOrder notifications by selecting the following Subscription Event type: 

  Subscription Event: SPWorkOrderNotification

This is a top-level event type. Every notification of the SPWorkOrderNotification event type carries a payload. This payload encapsulates a Work Request Notification emitted by SPG. This notification in turn can be 1 of several supported types:

  • CreateWorkOrderNotify - new work order has been assigned to the service partner
  • AddTaskNotify - new task has be added to an existing work order
  • CloseTaskNotify - a task has been closed by TFF after a review (success or redo)
  • UpdateWorkOrderSupplementaryReferencesNotify - a PO Number has been attached to the Work Order
  • UpdateWorkOrderAdditionalInfosNotify - worklog entry has been added to the Work Order
  • UpdateWorkOrderFileAttachmentsNotify - file attachments have been added to the Work Order
  • UpdateTaskAdditionalInfosNotify - worklog entry has been added to the Task
  • UpdateTaskFileAttachmentsNotify - file attachments have been added to the Task
  • PutOnHoldWorkOrderNotify - Work Order has been put on hold by TFF
  • ResumeWorkOrderNotify - Work Order has been resumed
  • CloseWorkOrderNotify - Work Order has been closed by TFF
  • CancelWorkOrderNotify - Work Order has been cancelled by TFF

Service Partner should implement a single POST /notification endpoint which accepts notifications of the SPWorkOrderNotification events with a payload of any of the types listed above.

Notification Webhook

Notification Webhook

Service Partner must implement this method to receieve SPWorkOrderNotification events from TFF. The payload of this event will be one of the several supported types:

  • CreateWorkOrderNotify - new work order has been assigned to the service partner
  • AddTaskNotify - new task has be added to an existing work order
  • CloseTaskNotify - a task has been closed by TFF after a review (success or redo)
  • UpdateWorkOrderSupplementaryReferencesNotify - supplementary references (e.g. PO Number) have been added to the Work Order
  • UpdateWorkOrderAdditionalInfosNotify - additional info (e.g. worklog entry) have been added to the Work Order
  • UpdateWorkOrderFileAttachmentsNotify - file attachments have been added to the Work Order
  • UpdateTaskAdditionalInfosNotify - additional info (e.g. worklog entry) have been added to the Task
  • UpdateTaskFileAttachmentsNotify - file attachments have been added to the Task
  • PutOnHoldWorkOrderNotify - Work Order has been put on hold by TFF
  • ResumeWorkOrderNotify - Work Order has been resumed
  • CloseWorkOrderNotify - Work Order has been closed by TFF
  • CancelWorkOrderNotify - Work Order has been cancelled by TFF
header Parameters
x-api-key
string

Used to pass a shared secret with each API request

X-Transaction-Id
string

Represents the unique message identifier associated with the transaction (when available).

Request Body schema: application/json
required
One of
eventId
required
string

A numeric value assigned to the event.

This is a monotonously increasing number over all SPWorkOrderNotification events that the SP is subscribed to. Any gaps in the eventId number sequence indicates a lost message.

eventTimestamp
required
string (common.datetime.cdatetime) (1|2\d{3})-(0[1-9]|1[012])-(0[1-9]|[12]\d|3[0...

LFC API Standard Date Time format The date and time in RFC3339 with 'Z' as tzd, microseconds optional, valid formats are ["yyyy-MM-dd'T'HH:mm:ssZ", "yyyy-MM-dd'T'HH:mm:ss.SSSZ" ]

eventType
required
string
Value: "SPWorkOrderNotification"

The event type for this notification.

required
object (notification.message.CreateWorkOrderNotify)

The summary of CreateWorkOrderNotify notification

required
object (notification.payload.CreateWorkOrderNotify)

The full content of the CreateWorkOrderNotify notification

Responses

Request samples

Content type
application/json
Example
{
  • "eventId": "string",
  • "eventTimestamp": "string",
  • "eventType": "SPWorkOrderNotification",
  • "message": {
    },
  • "payload": {
    }
}