logo
API docs by Redocly

Webhook for notification of ONT Activation (v1.0.1)

Download OpenAPI specification:Download

E-mail: api@tuatahifibre.co.nz

This interface should be implemented by the subscribers wishing to receive notifications of ONT Activation eventa from TFF via API.

In order to start receiving notifications, the consumer must subscribe to the ONTActivation event type

Notification Webhook

Notification Webhook

The consumer must implement this method to receieve notifications from TFF. The payload of this event will be specific to the event type.

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
eventId
required
string

A numeric value assigned to the event.

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

eventTimestamp
required
string <date-time>

The date and time this event notification was issued.

eventType
required
string
Value: "ONTActivation"

The event type for this notification.

required
object (notification.ontactivation.Event.message)

Attribute of the Event

required
object

Original payload from the network

Responses

Request samples

Content type
application/json
{
  • "eventId": "string",
  • "eventTimestamp": "2019-08-24T14:15:22Z",
  • "eventType": "ONTActivation",
  • "message": {
    },
  • "payload": { }
}