{/* Generated from packages/config/src/events/catalogue.ts by scripts/docs/generate-webhook-docs.ts. Do not edit. */}
Every delivery is a JSON body with id (evt_ and a UUID), type, created (Unix seconds), api_version (2026-10-01), workspace, property (or null), severity, data and links.app. There are 9 event types.
finding.created
The data object of this event:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"finding_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"kind": {
"type": "string",
"maxLength": 80
},
"scope": {
"type": "string",
"maxLength": 40
},
"scope_key": {
"type": "string",
"maxLength": 500
},
"metrics": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 60
},
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
}
]
}
},
"basis": {
"type": "string",
"maxLength": 200
}
},
"required": [
"finding_id",
"kind",
"scope",
"scope_key",
"metrics",
"basis"
],
"additionalProperties": false
}
investigation.opened
The data object of this event:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"investigation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"metric": {
"type": "string",
"maxLength": 60
},
"trigger_kind": {
"type": "string",
"maxLength": 40
},
"data_through": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"investigation_id",
"metric",
"trigger_kind",
"data_through"
],
"additionalProperties": false
}
task.created
The data object of this event:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"task_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"key": {
"type": "string",
"maxLength": 40
},
"kind": {
"type": "string",
"maxLength": 60
},
"priority": {
"type": "string",
"maxLength": 20
},
"source": {
"type": "string",
"maxLength": 40
},
"title": {
"type": "string",
"maxLength": 300
}
},
"required": [
"task_id",
"key",
"kind",
"priority",
"source",
"title"
],
"additionalProperties": false
}
task.status_changed
The data object of this event:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"task_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"key": {
"type": "string",
"maxLength": 40
},
"from": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
]
},
"to": {
"type": "string",
"maxLength": 30
}
},
"required": [
"task_id",
"key",
"from",
"to"
],
"additionalProperties": false
}
task.verified
The data object of this event:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"task_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"key": {
"type": "string",
"maxLength": 40
},
"verified_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
},
"required": [
"task_id",
"key",
"verified_at"
],
"additionalProperties": false
}
task.closed
The data object of this event:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"task_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"key": {
"type": "string",
"maxLength": 40
},
"from": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
]
}
},
"required": [
"task_id",
"key",
"from"
],
"additionalProperties": false
}
report.ready
The data object of this event:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"report_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"data_through": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"period": {
"type": "object",
"properties": {
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"from",
"to"
],
"additionalProperties": false
}
},
"required": [
"report_id",
"version",
"data_through",
"period"
],
"additionalProperties": false
}
regression.detected
The data object of this event:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"run_id": {
"type": "string",
"maxLength": 80
},
"critical_count": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"clicks_28d_at_risk": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"unit": {
"type": "string",
"maxLength": 24
},
"basis": {
"type": "string",
"maxLength": 200
}
},
"required": [
"value",
"unit",
"basis"
],
"additionalProperties": false
},
"top": {
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"rule": {
"type": "string",
"maxLength": 80
},
"summary": {
"type": "string",
"maxLength": 300
}
},
"required": [
"url",
"rule",
"summary"
],
"additionalProperties": false
}
}
},
"required": [
"run_id",
"critical_count",
"clicks_28d_at_risk",
"top"
],
"additionalProperties": false
}
sync.failed
The data object of this event:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"run_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"source": {
"type": "string",
"maxLength": 20
},
"kind": {
"type": "string",
"maxLength": 20
},
"error": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
}
},
"required": [
"run_id",
"source",
"kind",
"error"
],
"additionalProperties": false
}