Cronitor · Schema

Cronitor Telemetry Event

Query parameters sent to the Cronitor Telemetry API to record a job execution event.

MonitoringCron JobsScheduled TasksAlertingUptimeTelemetryStatus Pages

Properties

Name	Type	Description
state	string	Job execution state.
env	string	Environment identifier (e.g. staging, production).
host	string	Server hostname.
message	string	URL-encoded status message.
metric	string	Metric value in format count:N, duration:N (seconds), or error_count:N.
series	string	Unique ID for correlating related events across a run.
status_code	integer	Job exit code.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/cronitor/json-schema/cronitor-telemetry-event-schema.json",
  "title": "Cronitor Telemetry Event",
  "description": "Query parameters sent to the Cronitor Telemetry API to record a job execution event.",
  "type": "object",
  "required": ["state"],
  "properties": {
    "state": {
      "type": "string",
      "enum": ["run", "complete", "fail", "ok"],
      "description": "Job execution state.",
      "example": "complete"
    },
    "env": {
      "type": "string",
      "description": "Environment identifier (e.g. staging, production).",
      "example": "production"
    },
    "host": {
      "type": "string",
      "description": "Server hostname.",
      "example": "app-server-01"
    },
    "message": {
      "type": "string",
      "maxLength": 2000,
      "description": "URL-encoded status message.",
      "example": "Processed 1423 records successfully"
    },
    "metric": {
      "type": "string",
      "description": "Metric value in format count:N, duration:N (seconds), or error_count:N.",
      "pattern": "^(count|duration|error_count):\\d+(\\.\\d+)?$",
      "example": "duration:45.2"
    },
    "series": {
      "type": "string",
      "description": "Unique ID for correlating related events across a run.",
      "example": "job-run-20260612-abc123"
    },
    "status_code": {
      "type": "integer",
      "description": "Job exit code.",
      "example": 0
    }
  },
  "additionalProperties": false
}