StatusGator Support

Webhook Version 3.0

Open navigation

Webhook Version 3.0

Below you'll find an example payload from the Webhook v3.0 along with an explanation of each field.

  "type": "StatusChange",
  "recorded_at": "2025-07-17T02:20:45Z",
  "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 - Always StatusChange at present. Future event types will be added with different strings.
  • recorded_at - The timestamp at which we detected the change in the status.
  • 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.

If you have any questions or problems, please email us or submit a ticket.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.