Rollbar · Schema

Rollbar Webhook Payload

Schema for Rollbar webhook notification payloads. All webhook events share a common structure with event_name and data top-level keys. The data content varies by event type.

Error TrackingMonitoringDebuggingDevOpsApplication Performance

Properties

Name Type Description
event_name string The type of event that triggered the webhook notification.
data object The event data containing information about what triggered the webhook. The structure depends on the event_name.
View JSON Schema on GitHub

JSON Schema

rollbar-webhook-payload-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rollbar.com/schemas/rollbar/webhook-payload.json",
  "title": "Rollbar Webhook Payload",
  "description": "Schema for Rollbar webhook notification payloads. All webhook events share a common structure with event_name and data top-level keys. The data content varies by event type.",
  "type": "object",
  "required": ["event_name", "data"],
  "properties": {
    "event_name": {
      "type": "string",
      "description": "The type of event that triggered the webhook notification.",
      "enum": [
        "new_item",
        "occurrence",
        "exp_repeat_item",
        "item_velocity",
        "resolved_item",
        "reactivated_item",
        "reopened_item",
        "deploy"
      ]
    },
    "data": {
      "type": "object",
      "description": "The event data containing information about what triggered the webhook. The structure depends on the event_name.",
      "properties": {
        "item": {
          "$ref": "#/$defs/WebhookItem"
        },
        "occurrence": {
          "$ref": "#/$defs/WebhookOccurrence"
        },
        "deploy": {
          "$ref": "#/$defs/WebhookDeploy"
        },
        "occurrences": {
          "type": "integer",
          "description": "The occurrence count threshold that was crossed. Present in exp_repeat_item events (e.g., 10, 100, 1000).",
          "minimum": 1
        },
        "rate": {
          "type": "number",
          "description": "The occurrence rate that triggered the event. Present in item_velocity events."
        }
      }
    }
  },
  "$defs": {
    "WebhookItem": {
      "type": "object",
      "description": "Item data included in webhook payloads. Contains the same data returned by the REST API Read endpoints.",
      "properties": {
        "id": {
          "type": "integer",
          "description": "The internal item ID."
        },
        "counter": {
          "type": "integer",
          "description": "The project-specific counter."
        },
        "environment": {
          "type": "string",
          "description": "The environment where the item was seen."
        },
        "title": {
          "type": "string",
          "description": "The title or summary of the item."
        },
        "level": {
          "type": "string",
          "description": "The severity level.",
          "enum": ["critical", "error", "warning", "info", "debug"]
        },
        "status": {
          "type": "string",
          "description": "The item workflow status.",
          "enum": ["active", "resolved", "muted"]
        },
        "total_occurrences": {
          "type": "integer",
          "description": "Total number of occurrences.",
          "minimum": 0
        },
        "project_id": {
          "type": "integer",
          "description": "The project ID."
        },
        "first_occurrence_timestamp": {
          "type": "integer",
          "description": "Unix timestamp of the first occurrence."
        },
        "last_occurrence_timestamp": {
          "type": "integer",
          "description": "Unix timestamp of the most recent occurrence."
        }
      }
    },
    "WebhookOccurrence": {
      "type": "object",
      "description": "Occurrence data included in webhook payloads for occurrence events.",
      "properties": {
        "id": {
          "type": "integer",
          "description": "The occurrence instance ID."
        },
        "timestamp": {
          "type": "integer",
          "description": "Unix timestamp of the occurrence."
        },
        "version": {
          "type": "string",
          "description": "The code version when the occurrence happened."
        },
        "data": {
          "type": "object",
          "description": "Full occurrence data payload."
        }
      }
    },
    "WebhookDeploy": {
      "type": "object",
      "description": "Deploy data included in webhook payloads for deploy events.",
      "properties": {
        "id": {
          "type": "integer",
          "description": "The deploy ID."
        },
        "environment": {
          "type": "string",
          "description": "The environment deployed to."
        },
        "project_id": {
          "type": "integer",
          "description": "The project ID."
        },
        "revision": {
          "type": "string",
          "description": "The revision or commit SHA."
        },
        "local_username": {
          "type": "string",
          "description": "The local username of the deployer."
        },
        "comment": {
          "type": "string",
          "description": "The deploy comment."
        },
        "user_id": {
          "type": "integer",
          "description": "The Rollbar user ID."
        },
        "start_time": {
          "type": "integer",
          "description": "Unix timestamp when the deploy started."
        },
        "finish_time": {
          "type": "integer",
          "description": "Unix timestamp when the deploy finished."
        }
      }
    }
  }
}