Hoppa till innehållet
Sursa Developers

Händelser · Personer och åtkomst

api_key.expiring

API-nyckel går snart ut

En API-nyckel går ut inom 7 dagar. Händelsen skickas en gång per utgångsdatum.

Objekttyp
api_key
Levereras till
Webhookar med rollen admin

Nyttolast

Objekt: EventApiKeyExpiring

  • idstringobligatorisk

    Händelsens id (evt_…), skickas också som huvudet webhook-id. Använd det för att kasta dubblettleveranser.

  • typestringobligatorisk

    Tillåtna värden: api_key.expiring

  • created_atstring (date-time)obligatorisk

    När ändringen inträffade (UTC).

  • org_idintegerobligatorisk
  • api_versionstringobligatorisk

    Kontraktsversion för schemat data.

  • sequenceinteger

    Leveransens löpnummer inom webhooken (saknas för en testhändelse).

  • objectWebhookEventObjectobligatorisk
  • payloadstringobligatorisk

    thin betyder ingen data: läs objektet via API:et.

    Tillåtna värden: fullthin

  • dataobject
    Fält
    • api_keyEventAPIKeyobligatorisk
    • days_leftintegerobligatorisk

      Dagar kvar tills nyckeln går ut.

  • testbooleanobligatorisk

    En testhändelse som skickas av POST /v1/webhooks/{webhook_id}/test.

Exempel på leverans

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "api_key.expiring",
  "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"
    },
    "days_left": 6
  },
  "test": false
}

Ta emot händelser

Varje leverans är ett POST-anrop med den här JSON-brödtexten till din mottagare. Verifiera huvudet webhook-signature (Standard Webhooks) innan du litar på brödtexten, svara med en 2xx-status inom några sekunder och gör arbetet efteråt. Leveranserna till en och samma webhook kommer i samma ordning som händelserna; en misslyckad leverans görs om med allt längre pauser.

Nya händelsetyper och nya fält kan tillkomma när som helst: hoppa över de typer och fält som du inte känner till.

Samma händelser finns i händelseflödet i 30 dagar →