Skip to main content

Notification Types

Every notification sent by the Messaging Gateway has a common format, depending on the notification type.

All outgoing messages from Equinix have the following components:

{  
"Task": {  
    "Header attribute 1": "",  
    "Header attribute 2": "",  
    "Header attribute 3": "",  
    ...  
    "Body": {  
    "Body attribute 1": "",  
    "Body attribute 2": "",  
    "Body attribute 3": "",  
    ...  
    }  
},  
"Signature": "Base 64 encrypted signature"  
}

These header attributes are applicable to all order types.

  • ID - String (Guid) - The unique identifier of the message. Equinix will send a unique value for each message.
  • Source - String (Guid) - A unique value to identify the message sender. This value will be shared with the customer during the onboarding process.
  • Verb - String - Update. This indicates there is an update from Equinix.
  • Resource - String - Equinix Product Name for which the notification is being sent.
  • ContentType - String - "application/json"
  • CreateTimeUTC - String - Indicates the date and time at which the notification is sent by Equinix.
  • Version - String - The version of the notification schema.

The body attributes vary for each notification type.

Billing Notifications​

Billing Notifications are near real-time notifications triggered when the customer order is closed and billing is started by Equinix. These notifications will be triggered for all customers orders submitted through both offline and online channels.

Resellers will also receive billing notifications when billing starts for orders placed by customers.

Sample Notification:

{  
"Task": {  
    "Id": "la83ef18-5e36-4a2d-9d80-490ee217d004",  
    "Source": "3e095d30-40ff-11e9-8959-5be078353003",  
    "Verb": "Update",  
    "Resource": "CrossConnnect",  
    "ContentType": "application/json",  
    "CreationTimeUTC": "2021-06-16T19:57:21.326Z",  
    "Version": "1.0",  
    "Body": {  
    "RequestorId": "",  
    "ServicerId": "1-205346710865",  
    "State": "Closed",  
    "Description": "Order Number:1-205346710865 billing notification",  
    "LineDetails": [  
        {  
        "Id": "1-3N5W5LYZ",  
        "Ibx": "DC1",  
        "Status": "Billed",  
        "BilledLines": [  
            "1-2N5W4JAS",  
            "1-2N5W4K87",  
            "1-2N5W3M21",  
            "1-2N5235N2"  
        ]  
        }  
    ]  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="  
}

Billing notifications have the following body attributes:

  • Body - Object - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.

    • RequestorId - String - Customer reference number for the maintenance (if any).
    • ServicerId - String - Indicates the unique id supplied by Equinix for the submitted order.
    • State - String - Indicates the current state of Order. Supported Value - 'Closed'.
    • Description - Object - Summary of the ticket from Billing System.
    • LineDetails - Array - An array of object containing the details of the Billed Line Items and data center:
      • Id - Unique Billing Line ID.
      • Ibx - Name of the DataCenter/IBX.
      • Status : Supported value "Billed".
      • BilledLines : Array of Billed Line Items as of type "String".

Fabric Notifications​

The Messaging Gateway supports Fabric Notifications for below workflows:

  • Equinix Fabric Port Up/Down
  • Equinix Fabric Virtual Connection Up/Down

Sample Notification:

{  
"Task": {  
    "Id": "bf9f2707-d612-4d63-9958-4c8b1fcf3cc0",  
    "Source": "3e095d30-40ff-11e9-8959-5be078353003",  
    "Verb": "Update",  
    "Resource": "DataCenter.Network.Port",  
    "ContentType": "application/json",  
    "Version": "1.0",  
    "Body": {   
    "timestamp":"2020-05-21T10:20:00Z",  
    "type":"PORT_OPSTATUS_NOTIFICATION",  
    "uuid":"11c954fb-8e8b-4515-97d7-cc80129a0985",  
    "description":"Port is not operational. Connections on this port might be affected.",  
    "data":{  
        "type":"XF_PORT",  
        "uuid":"a867f685-41b0-1b07-6de0-320a5c00abdd",  
        "name":"L2-DEV-USER01-DC5-CX-10G-SECONDARY-NOKIA-02",  
        "href":"https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",  
        "operation":{  
            "operationalStatus":"DOWN",  
            "opStatusChangedAt":"2020-05-21T10:20:00Z",  
            "maintenanceMode":false  
        },  
        "embedded":{  
            "connections":{  
                "href":[  
                "https://api.equinix.com/fabric/v4/connections/8822de74-805f-4f63-b52d-93bcbf2a1d1b",  
                "https://api.equinix.com/fabric/v4/connections/8f20bea9-a5b9-47e5-88e6-a899584ebb90"  
                ]  
            }  
        }  
    }  
  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="  
}

Fabric notifications have the following body attributes:

  • Body - Object - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.

    • type - String - Indicates type of notification. PORT_OPSTATUS_NOTIFICATION indicates Fabric Port is currently under maintenance. CONNECTION_OPSTATUS_NOTIFICATION indicated Fabric Virtual Connection is currently under maintenance.
    • uuid - String - Indicates the unique id supplied by Equinix for the maintenance.
    • description - String - Summary of the ticket from an Equinix Technician.
    • data - Object - An object containing the details of the customer port.
    • type - String - Indicates port type. XF_PORT indicates Equinix Fabric Port. "EVPL_VC" indicates Equinix Fabric Virtual Connection.
    • uuid - String - Indicates the unique id of the customer port.
    • name - String - Indicates name of the customer port.
    • href - String - Link to get more details of the customer port.
    • operation - Object - An object containing the details related to the status of the customer port.
    • operationalStatus - String - Indicates the current status of the customer port.
    • opStatusChangedAt - String - Indicates the date and time at which the status of the customer port last monitored.
    • maintenanceMode - Boolean - Indicates if its a planned or unplanned maintenance.
    • embedded - Object - An object containing the details of the virtual connections active on this customer port.
    • connections - Object - An object containing the list of the virtual connections active on this customer port.
    • href - Array[String] - An array containing the list of the virtual connections active on this customer port.

IBX Notifications​

IBX Notifications are near real-time notifications for any planned and unplanned Equinix IBX data center maintenance. These notifications are also triggered for any Equinix IBX data center incidents and advisory.

Messaging Gateway supports below IBX notifications variants:

  • IBX Maintenance Notifications
  • IBX Incidents Notifications
  • IBX Advisory Notifications
  • IBX Security Incident Notifications

Sample Notification:

{  
"Task": {  
    "Id": "370da978-b9bd-4030-b012-9dc97e2fdf98",  
    "Source": "3e095d30-40ff-11e9-8959-5be078353003",  
    "Verb": "Update",  
    "Resource": "DataCenter.Maintenance",  
    "ContentType": "application/json",  
    "CreationTimeUTC": "2021-06-09T07:42:45.396Z",  
    "Version": "1.0",  
    "Body": {  
    "RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",  
    "ServicerId": "5-204454471282",  
    "State": "CONFIRMED",  
    "Description": "Equinix Test Maintenance",  
    "Sequence": "2",  
    "StartDateTime": "2021-03-29T17:33:00",  
    "EndDateTime": "2021-03-31T18:00:00",  
    "AccountNumber": "123456",  
    "Impact": "NON_SERVICE_IMPACTING",  
    "ProdID": "DataCenter Notification https://developer.equinix.com",  
    "Organizer": "Global Service Desk:mailto:support@equinix.com",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==  
"  
}

IBX notifications have the following body attributes:

  • Body - Object - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.

    • RequestorId - String - Customer reference number for the maintenance (if any).
    • ServicerId - String - Indicates the unique id supplied by Equinix for the datacenter maintenance/incident.
    • State - String - Current State of the ticket Supported Values:
      • CONFIRMED - DataCenter Maintenance/Incident is Confirmed.
      • IN-PROCESS - DataCenter Maintenance/Incident currently in progress.
      • COMPLETED - DataCenter Maintenance/Incident is Completed.
      • CANCELLED - DataCenter Maintenance/Incident has been Cancelled.
    • Description - Object - Summary of the ticket from an Equinix Technician.
    • Sequence - Number - Incrementing number for the related notifications. The number starts from 0.
    • StartDateTime - String - Indicates the Start Date and Time of maintenance.
    • EndDateTime - String - Indicates the End Date and Time of maintenance. This value will always be populated for Resource of Type"DataCenter. Maintenance" This value will only be populated for State as "COMPLETED" for the Resource Types - DataCenter.Incident, DataCenter.SecurityIncident and DataCenter.Advisory.
    • AccountNumber - String - Indicates the Customer's Account Number related to the maintenance activity.
    • Impact - String - Indicates the level/severity of impact to the customer due to the maintenance activity or incident. Supported Values:
      • SERVICE_IMPACTING - indicates the activity or incident that affects your services.
      • NON_SERVICE_IMPACTING - indicates the activity or incident that does not disrupt your services,like when backup servers keep things running despite repairs.
    • ProdID - String - Indicates the link to refer the more information on the maintenance activity.
    • Organizer - String - Indicates the name of maintenance organizer with Email Id. Global Service Desk:support@equinix.com.
    • Assets - Object - This value will be populated for Resource of Types "DataCenter.Maintenance" and "DataCenter.Incident". An object containing the details of the impacted customer assets with the attributes:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Network Notifications​

Network Notifications are near real-time notifications for any planned and unplanned Equinix Product or Service Network maintenance. These notifications are also triggered for any Equinix Product or Service Network incidents.

Messaging Gateway supports below Network Notifications variants

  • Network Maintenance Notifications
  • Network Incidents Notifications

Sample Notification:

{  
"Task": {  
    "Id": "370da978-b9bd-4030-b012-9dc97e2fdf98",  
    "Source": "3e095d30-40ff-11e9-8959-5be078353003",  
    "Verb": "Update",  
    "Resource": "Network.Maintenance",  
    "ContentType": "application/json",  
    "CreationTimeUTC": "2021-06-09T07:42:45.396Z",  
    "Version": "1.0",  
    "Body": {  
    "RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",  
    "ServicerId": "5-204454471282",  
    "State": "CONFIRMED",  
    "Description": "Equinix Test Maintenance",  
    "Sequence": "2",  
    "StartDateTime": "2021-03-29T17:33:00",  
    "EndDateTime": "2021-03-31T18:00:00",  
    "AccountNumber": "123456",  
    "Impact": "NON_SERVICE_IMPACTING",  
    "ProdID": "Network Notification https://developer.equinix.com",  
    "Organizer": "Global Service Desk:mailto:support@equinix.com",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="  
}

Network notifications have the following body attributes:

  • Body - Object - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.

    • RequestorId - String - Customer reference number for the maintenance (if any).
    • ServicerId - String - Indicates the unique id supplied by Equinix for the Network maintenance/incident.
    • State - String - Current State of the ticket Supported Values:
      • CONFIRMED - DataCenter Maintenance/Incident is Confirmed.
      • IN-PROCESS - DataCenter Maintenance/Incident currently in progress.
      • COMPLETED - DataCenter Maintenance/Incident is Completed.
      • CANCELLED - DataCenter Maintenance/Incident has been Cancelled.
    • Description - Object - Summary of the ticket from an Equinix Technician.
    • Sequence - Number - Incrementing number for the related notifications. The number starts from 0.
    • StartDateTime - String - Indicates the Start Date and Time of maintenance.
    • EndDateTime - String - Indicates the End Date and Time of maintenance. This value will always be populated for Resource of Type "Network.Maintenance" This value will only be populated for State as "COMPLETED" for Resource of Type "Network.Incident".
    • AccountNumber - String - Indicates the Customer's Account Number related to the maintenance activity.
    • Impact - String - Indicates the level/severity of impact to the customer due to the maintenance activity or incident. Supported Values:
      • SERVICE_IMPACTING - indicates the activity or incident that affects your services.
      • NON_SERVICE_IMPACTING - indicates the activity or incident that does not disrupt your services,like when backup servers keep things running despite repairs.
    • ProdID - String - Indicates the link to refer the more information on the maintenance activity. |
    • Organizer - String - Indicates the name of maintenance organizer with Email Id. Global Service Desk: support@equinix.com
    • Assets - Object - This value will be populated for Resource of Types "Network.Maintenance" and "Network.Incident". An object containing the details of the impacted customer assets with the attributes:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type