Tapahtumat · Työt ja viennit
job.failed
Työ epäonnistui
Taustatyö epäonnistui tai peruutettiin (data.reason on neutraali koodi).
- Objektin tyyppi
- job
- Vastaanottavat webhookit
- Webhookit, joilla on admin-rooli
Hyötykuorma
idstringpakollinenTapahtuman tunnus (
evt_…), joka lähetetään myöswebhook-id-otsakkeena. Käytä sitä kaksoistoimitusten pudottamiseen.typestringpakollinenSallitut arvot:
job.failedcreated_atstring (date-time)pakollinenMilloin muutos tapahtui (UTC).
org_idintegerpakollinenapi_versionstringpakollinendata-skeeman sopimusversio.sequenceintegerToimituksen järjestysnumero webhookin sisällä (puuttuu testitapahtumalta).
payloadstringpakollinenthintarkoittaa, etteidata-kenttää ole: lue objekti API:n kautta.Sallitut arvot:
fullthindataobjectKentät
reasonstringpakollinenNeutraali syykoodi (laajennettava luettelo: käsittele tuntematonta koodia yleisenä virheenä). Esimerkkejä:
canceled,timeout,unprocessable,internal.
testbooleanpakollinenPOST /v1/webhooks/{webhook_id}/test-toiminnon lähettämä testitapahtuma.
Esimerkkitoimitus
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "job.failed",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "job",
"id": "4410"
},
"payload": "full",
"data": {
"job": {
"id": 4410,
"kind": "index",
"status": "error",
"card_id": "c_9f2e41",
"collection": "support",
"batch_id": null,
"title": "Refund policy.pdf",
"finished_at": "2026-10-24T10:00:03Z"
},
"reason": "timeout"
},
"test": false
}Tapahtumien vastaanottaminen
Jokainen toimitus on POST-pyyntö webhookisi URL-osoitteeseen, ja sen runkona on tämä JSON. Tarkista webhook-signature-otsake (Standard Webhooks) ennen kuin luotat runkoon, vastaa 2xx-tilalla muutaman sekunnin kuluessa ja tee varsinainen työ vasta sen jälkeen. Saman webhookin toimitukset säilyttävät tapahtumien järjestyksen; epäonnistunutta toimitusta yritetään uudelleen yhä pidemmin tauoin.
Uusia tapahtumatyyppejä ja uusia kenttiä voi ilmestyä milloin tahansa: ohita tyypit ja kentät, joita et tunne.