Subscribe to Service Status messages via WebHook API

book

Article ID: 207677

calendar_today

Updated On:

Products

Support Portal

Issue/Introduction

As a trusted advisor to our customers, our status sites provide transparency around service availability and performance for Broadcom software products.

By subscribing through the Service Status website, you can be notified of service interruptions and maintenance notifications to Broadcom’s Enterprise Software and Security products, in a single view, without authenticating through a portal.

Broadcom provides the ability to receive a message when an incident is created or updated through a WebHook API endpoint.

Webhooks are HTTP POST requests that our servers send to the registered endpoint.

Endpoints are required to respond with a 2xx response code (3xx is considered a failure), and must respond within 30 seconds of initial connection.

Resolution

Subscribe to receive incident updates and maintenance status messages via WebHook API:

  1. Go to Service Status.
  2. Click on a product tile to go to the appropriate product status website.
  3. In the upper-right corner of the page, click SUBSCRIBE.



  4. Click on the WebHook API icon (presented as code parenthesis < >)

  5. Next, enter in the URL of the endpoint that will receive the POST request and an email address so that we can notify you if Broadcom is unable to reach the endpoint.

  6. Click on Subscribe to register the endpoint.

Additional Information

WebHooks will send a POST request in JSON format. For example:

{
   "meta":{
      "unsubscribe":"http://statustest.flyingkleinbrothers.com:5000/?unsubscribe=j0vqr9kl3513",
      "documentation":"http://doers.statuspage.io/customer-notifications/webhooks/"
   },
   "page":{
      "id": "j2mfxwj97wnj",
      "status_indicator": "critical",
      "status_description": "Major System Outage"
   },
   "incident":{
      "backfilled":false,
      "created_at":"2013-05-29T15:08:51-06:00",
      "impact":"critical",
      "impact_override":null,
      "monitoring_at":"2013-05-29T16:07:53-06:00",
      "postmortem_body":null,
      "postmortem_body_last_updated_at":null,
      "postmortem_ignored":false,
      "postmortem_notified_subscribers":false,
      "postmortem_notified_twitter":false,
      "postmortem_published_at":null,
      "resolved_at":null,
      "scheduled_auto_transition":false,
      "scheduled_for":null,
      "scheduled_remind_prior":false,
      "scheduled_reminded_at":null,
      "scheduled_until":null,
      "shortlink":"http://j.mp/18zyDQx",
      "status":"monitoring",
      "updated_at":"2013-05-29T16:30:35-06:00",
      "id":"lbkhbwn21v5q",
      "organization_id":"j2mfxwj97wnj",
      "incident_updates":[
         {
            "body":"A fix has been implemented and we are monitoring the results.",
            "created_at":"2013-05-29T16:07:53-06:00",
            "display_at":"2013-05-29T16:07:53-06:00",
            "status":"monitoring",
            "twitter_updated_at":null,
            "updated_at":"2013-05-29T16:09:09-06:00",
            "wants_twitter_update":false,
            "id":"drfcwbnpxnr6",
            "incident_id":"lbkhbwn21v5q"
         },
         {
            "body":"We are waiting for the cloud to come back online and will update when we have further information",
            "created_at":"2013-05-29T15:18:51-06:00",
            "display_at":"2013-05-29T15:18:51-06:00",
            "status":"identified",
            "twitter_updated_at":null,
            "updated_at":"2013-05-29T15:28:51-06:00",
            "wants_twitter_update":false,
            "id":"2rryghr4qgrh",
            "incident_id":"lbkhbwn21v5q"
         },
         {
            "body":"The cloud, located in Norther Virginia, has once again gone the way of the dodo.",
            "created_at":"2013-05-29T15:08:51-06:00",
            "display_at":"2013-05-29T15:08:51-06:00",
            "status":"investigating",
            "twitter_updated_at":null,
            "updated_at":"2013-05-29T15:28:51-06:00",
            "wants_twitter_update":false,
            "id":"qbbsfhy5s9kk",
            "incident_id":"lbkhbwn21v5q"
         }
      ],
      "name":"Virginia Is Down"
   }
}

Attachments