Docs
API 1.39
Status
Objects

WebhookEvent

The WebhookEvent object of the Kaabist API.

FieldTypeRequiredDescription
idstringyespattern ^evt_[0-9a-hjkmnp-tv-z]{26}$
type"job.queued"yes
created_atstring (date-time)yes
orgstringyespattern ^org_[0-9a-hjkmnp-tv-z]{26}$
mode"live", "test"yes
dataobjectyes
data.jobstringyespattern ^job_[0-9a-hjkmnp-tv-z]{26}$
data.programstring or nullyes
data.reason"obstacle", "drift", "unknown_page", "session_expired", "side_effect_ambiguous", "captcha" or enum (58 values)
data.urlstring (uri)yes
data.batchstringyespattern ^bat_[0-9a-hjkmnp-tv-z]{26}$
data.totalintegeryes≥ 0
data.proposalstringyespattern ^prp_[0-9a-hjkmnp-tv-z]{26}$
data.kind"relocate", "dismiss", "insert_steps", "parser_config", "api_discovery"
data.decision"approved", "rejected"
data.schedulestringyespattern ^sch_[0-9a-hjkmnp-tv-z]{26}$
data.statusenum (7 values)yesone of "queued", "running", "awaiting_input", "needs_attention", "succeeded", "failed", "canceled"
data.changedboolean
data.changed_pathsstringyesmax items 50
data.changed_paths_truncatedboolean
data.diff_urlstring (uri)yes
data.failure_streakintegeryes≥ 1
data.sessionstringyespattern ^ses_[0-9a-hjkmnp-tv-z]{26}$
data.namestringyes
data.program_version_idstringyespattern ^pv_[0-9a-hjkmnp-tv-z]{26}$
data.fieldstringyes
data.detailstringyes
data.source"statistics", "canary"yes
data.atstring (date-time)yes
data.balancenumberyes
data.levelinteger≥ 0 · ≤ 100
data.thresholdnumber
data.byostringyespattern ^byo_[0-9a-hjkmnp-tv-z]{26}$
data.webhookstringyespattern ^whk_[0-9a-hjkmnp-tv-z]{26}$
data.failing_sincestring (date-time)yes

#Example

{
  "id": "evt_01j9zqk3q7m4n5p6r7s8t9v0wx",
  "type": "job.needs_attention",
  "created_at": "2026-09-18T10:00:00Z",
  "org": "org_01j9zqk3q7m4n5p6r7s8t9v0wx",
  "mode": "live",
  "data": {
    "job": "job_01j9zqk3q7m4n5p6r7s8t9v0wx",
    "reason": "obstacle",
    "program": "acme-report@3",
    "url": "https://api.kaab.ist/v1/jobs/job_01j9zqk3q7m4n5p6r7s8t9v0wx"
  }
}

Was this page helpful?