Push Notification API

× Please to view API detail.

The Push Notification API publishes notification messages to subscribed URLs based on your subscription preferences. The notification types supported by this API are:

  • Order Notifications (NBN order updates)
  • Ticket Notifications (NBN and Copper tickets)
  • Diagnostics Result Notifications (NBN and Copper diagnostic tests)
  • Ticket Create Result Notifications (NBN and Copper tickets)
  • Appointment Reschedule Result Notifications (Copper only)
  • Call Diversion Result Notifications (Copper only)
  • Isolate Line Hunt Result Notifications (Copper only)

The messages delivered for each notification type can have multiple event types. For example, possible Order Notification event types are OrderUpdate, AppointmentUpdate, NotesAdded and Reminder. A separate set of event types applies for each notification type - see the API specification on the Supporting Material page for further details.

The notification will indicate whether or not you are required to take further action. 'FYA' means that further action is required while 'FYI' means that the notification is for information only.

The messages delivered to you will be delivered on a 'first in, first out' basis. If your system is not available for a period of time or your system has not provided a successful Response Code [link to the paragraph to be added in supporting materials] and notification delivery fails, the API will retry sending several times over one hours. Messages that cannot be delivered will remain available for you to retrieve using the Pull Notification API. However, there is a limitation on the number of days an event will be available through Pull Notifications. Please see the Pull Notification API page for further details.

It should be noted that in retry scenarios the messages may be received out of sequence and you will have to manage this scenario based on the event timestamp.

As the API can deliver 50 messages concurrently, you are required to support 50 concurrent sessions, otherwise some messages may go into retry mode regardless of your system being available.

Benefits

The key benefits of Push Notification API inlcudes the following:

  • This offers the ability to receive notifications without having to poll TW systems.
  • This will enable you to keep your systems in sync with TW reducing the need for your staff to access TW systems directly.
  • You can use this API to identify events that your systems can use to automatically generate tasks and notifications for your internal staff and customers.
  • The Notifications provided for NBN LOLO include additional events and information that are not currently provided via the NBN LOLO KMI email notifications.

Terms and Conditions

Use of the Telstra Push Notification API is bound by these Terms and Conditions. By agreeing to the overall t.dev Terms and Conditions when you sign up an account, you agree to all API specific Terms and Conditions.