Sündmused · Inimesed ja juurdepääs
api_key.revoked
API-võti tühistatud
API-võti tühistati ja see lakkab töötamast.
- Objekti tüüp
- api_key
- Vastuvõtvad veebihaagid
- Veebihaagid, millel on roll admin
Sisu
idstringkohustuslikSündmuse ID (
evt_…), mis saadetakse ka päisenawebhook-id. Kasutage seda topeltedastuste kõrvaldamiseks.typestringkohustuslikLubatud väärtused:
api_key.revokedcreated_atstring (date-time)kohustuslikMillal muudatus toimus (UTC).
org_idintegerkohustuslikapi_versionstringkohustuslikSkeemi
datalepingu versioon.sequenceintegerEdastuse järjekorranumber veebihaagi piires (testsündmuse puhul puudub).
payloadstringkohustuslikthintähendab, et väljadataei ole: lugege objekti API kaudu.Lubatud väärtused:
fullthindataobjectVäljad
actor_idinteger | nullkohustuslikKasutaja, kes toimingu tegi; organisatsiooni API-võtme või platvormi enda puhul
null.reasonstringTühistamise põhjus:
manualvõiuser_offboarded.
testbooleankohustuslikTestsündmus, mille saatis
POST /v1/webhooks/{webhook_id}/test.
Näidisedastus
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "api_key.revoked",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "api_key",
"id": "14"
},
"payload": "full",
"data": {
"api_key": {
"id": 14,
"name": "CRM sync",
"prefix": "kb_3f9a",
"kind": "org",
"role": "editor",
"scopes": [
"cards:read",
"cards:write"
],
"expires_at": "2026-10-31T00:00:00Z"
},
"actor_id": 7,
"reason": "manual"
},
"test": false
}Sündmuste vastuvõtmine
Iga edastus on selle JSON-kehaga POST-päring teie veebihaagi URL-ile. Enne keha usaldamist kontrollige päist webhook-signature (Standard Webhooks), vastake mõne sekundi jooksul olekuga 2xx ja tehke töö ära hiljem. Ühe veebihaagi edastused säilitavad sündmuste järjekorra; ebaõnnestunud edastust proovitakse uuesti üha pikemate vahedega.
Uued sündmusetüübid ja uued väljad võivad ilmuda igal ajal: jätke tundmatud tüübid ja väljad vahele.