Webhook version 3.0

Webhook version 3.0

StatusGator’s webhook version 3.0 is the current, recommended schema for receiving webhook notifications. It introduces structured event types and richer payloads that are easier to parse and automate against.

Event types

• StatusChange – sent when a monitor’s status changes (overall or component-level).
• EarlyWarningSignal – sent when StatusGator detects a possible outage before it’s confirmed.

Payload examples

Early Warning Signals

{
  "type": "EarlyWarningSignal",  // The notification type
  "recorded_at": "2025-01-29T20:54:48Z",  // ISO8601 UTC timestamp
  "service": {
    "id": "M1xKnyloHR",
    "name": "Resideo",
    "slug": "resideo",
    "home_page_url": "https://resideo.com",
    "status_page_url": "https://status.resideo.com",
    "icon_url": "https://favicons.statusgator.com/resideo.png",
    "landing_page_url": "https://statusgator.com/services/resideo"
  },
  "monitor": {
    "id": "uZoM2YK1rn",
    "type": "ServiceMonitor",
    "display_name": "Resideo",
    "icon_url": "https://favicons.statusgator.com/resideo.png"
  },
  "board": {
    "id": "X1iMbb5HTm",
    "name": "123"
  },
  "summary": "Service outage",
  "yes_vote_url": "https://statusgator.com/signal_alerts/UkLWZg9DAJ/confirm",
  "no_vote_url": "https://statusgator.com/signal_alerts/UkLWZg9DAJ/deny"
}

Status Changes

  "type": "StatusChange",  // The notification type
  "recorded_at": "2025-07-17T02:20:45Z",  // ISO8601 UTC timestamp
  "service": {
    "id": "OUQJLhNcSb",
    "name": "OpenAI",
    "slug": "openai",
    "home_page_url": "https://openai.com",
    "status_page_url": "https://status.openai.com",
    "icon_url": "https://favicons.statusgator.com/openai.png",
    "landing_page_url": "https://statusgator.com/services/openai"
  },
  "monitor": {
    "id": "UIMPLWZg9D",
    "type": "ServiceMonitor",
    "display_name": "OpenAI",
    "icon_url": "https://favicons.statusgator.com/penai.png"
  },
  "board": {
    "id": "Pwg0NMcnNF",
    "name": "Demo 2"
  },
  "status": "up",
  "previous_status": "down",
  "message": "Elevated Error Rate on ChatGPT",
  "details": "We have identified that users are experiencing elevated errors for the impacted services. We are working on implementing a mitigation.",
  "component_status_changes": [
    {
      "group_name": "APIs",
      "name": "Chat",
      "last_status": "up",
      "current_status": "down"
    },
    {
      "group_name": "APIs",
      "name": "Images",
      "last_status": "up",
      "current_status": "down"
    }
  ]
}

• type - Either StatusChange or EarlyWarningSignal, depending on the type of event.
• recorded_at - The timestamp at which we detected the event.
• summary - Provided for Early Warning Signals only, a brief summary of outage reports we have received.
• yes_vote_url - Provided for Early Warning Signals only, a link to confirm you are having the same issue.
• no_vote_url - Provided for Early Warning Signals only, a link to deny you are having the same issue.
• service - A section of attributes that is present only for service monitors.
• service.id - A unique ID for the service.
• service.name - Our official name for this service. Your custom name will be in the monitor section.
• service.slug - A URL-friendly unique identifier for this service.
• service.home_page_url - The official home page URL of the service, if available.
• service.status_page_url - The official status page URL for the service, if available.
• service.icon_url - The URL of the default icon, suitable for use on a custom dashboard.
• service.landing_pgae_url - The URL of our public landing page for this service, where outages can be reported.
• board - A section of attributes about the board to which this monitor is attached.
• board.id - A unique ID for the board.
• board.name - Your board name.
• monitor.id - A unique ID for your monitor.
• monitor.type - The type of monitor. Can be ServiceMonitor, WebsiteMonitor, or PingMonitor.
• monitor - A section of attributes about your monitor.
• monitor.display_name - The name you set, which can differ from the official service name.
• monitor.icon_url - The icon URL for your monitor, which can differ from the official.
• monitor.url - Only present in the case of a WebsiteMonitor type. The URL you are monitoring.
• monitor.host - Only present in the case of a PingMonitor type. The host you are monitoring.
• status - The status the service changed to. Can be up, down, warn, or maintenance.
• previous_status - The status the service changed from.
• message - As short summary of the incident as provided by the service, if available.
• details - A longer multi-line description of the incident, as provided by the service, if available. `
• component_status_changes - An array of changes to components, for service monitors, if provided.
• component_status_changes.group_name - Group name of the component affected.
• component_status_changes.name - Name of the component affected.
• component_status_changes.last_status - The previous status of the service component.
• component_status_changes.current_status - The new status of the service component.