The Notification Pipeline

The notification pipeline is a websocket connection that broadcasts updates for a hub. It sends JSON messages over the socket, with a header field that can be used to determine the event that took place. From there, your application can determine if it needs to fetch additional data, or can react to real time updates.

Attributes
  • topic
    string

    A header topic, for the full list see the table included on this page.

  • object
    object

    The ID of the notification and potential state and error information.

    Show child fields
  • context
    object

    The context associated with this notification including but not limited to data on the hub, account, environment, DNS zone, cluster, or containers associated with this notification.

    Show child fields

Notification Headers

HeaderDescription
sdn.network.createdAn SDN network has been created.
sdn.network.reconfiguredAn SDN network has been reconfigured.
sdn.network.state.changedAn SDN networks state has changed.
environment.startedAn environment has been started.
environment.stoppedAn environment has been stopped
environment.services.reconfiguredAn environments services have been reconfigured.
container.state.changedA containers state has changed
container.instances.reconfiguredThe instances of a container have been reconfigured.
container.reconfiguredA container has been reconfigured.
internal.service.compute.connectedThe internal service 'compute' has connected.
dns.zone.records.reconfiguredA DNS Zone record has been reconfigured.
dns.zone.reconfiguredA DNS Zone has been reconfigured
dns.zone.record.certificate.readyA DNS Zone record certificate is ready.

UNAVAILABLE

It is not possible to make websocket connections in cURL without the use of a third-party tool.

Example Connection
cURL cannot be used to connect to a websocket.
Example Response
{
"topic": "sdn.network.reconfigured",
"object": {
"id": "5d71fa31db2ab0000167b87e",
"state": "",
"error": ""
},
"context": {
"hub_id": "5d71fa31db2ab0000167b87e",
"account_id": "5d71fa31db2ab0000167b87e",
"environments": [
"5d71fa31db2ab0000167b87e",
"5d71fa31db2ab0000167b87e"
],
"dns_zones": [],
"clusters": [
"production"
],
"containers": []
}
}