Ir al contenido
Sursa Developers

Eventos · Personas y acceso

api_key.expiring

Clave de API a punto de caducar

Una clave de API caduca en los próximos 7 días. El evento se envía una vez por fecha de caducidad.

Tipo de objeto
api_key
Se entrega a
Webhooks con el rol admin

Carga útil

Objeto: EventApiKeyExpiring

  • idstringobligatorio

    ID del evento (evt_…), que también se envía como encabezado webhook-id. Úselo para descartar entregas duplicadas.

  • typestringobligatorio

    Valores permitidos: api_key.expiring

  • created_atstring (date-time)obligatorio

    Cuándo se produjo el cambio (UTC).

  • org_idintegerobligatorio
  • api_versionstringobligatorio

    Versión del contrato del esquema de data.

  • sequenceinteger

    Número de secuencia de la entrega dentro del webhook (no aparece en un evento de prueba).

  • objectWebhookEventObjectobligatorio
  • payloadstringobligatorio

    thin significa sin data: lea el objeto a través de la API.

    Valores permitidos: fullthin

  • dataobject
    Campos
    • api_keyEventAPIKeyobligatorio
    • days_leftintegerobligatorio

      Días que faltan para que caduque la clave.

  • testbooleanobligatorio

    Un evento de prueba enviado por POST /v1/webhooks/{webhook_id}/test.

Ejemplo de entrega

{
  "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
}

Recepción de eventos

Cada entrega es una solicitud POST con este cuerpo JSON a la URL de su webhook. Compruebe el encabezado webhook-signature (Standard Webhooks) antes de confiar en el cuerpo, responda con un estado 2xx en pocos segundos y haga el trabajo después. Las entregas a un mismo webhook conservan el orden de los eventos; una entrega fallida se reintenta con pausas cada vez más largas.

En cualquier momento pueden aparecer tipos de evento y campos nuevos: omita los tipos y campos que no conozca.

Los mismos eventos están en el feed de eventos durante 30 días →