Skip to navigation
Referencia APIPlugins

Reportar conexión, versión o salud de un plugin

Registra telemetría reportada por la integración para la cuenta autenticada. No acepta montos ni confirmaciones de pagos. No demuestra un censo completo de instalaciones. Los eventos de Sandbox quedan fuera del dashboard LIVE. Envía Idempotency-Key en reintentos para evitar duplicar eventos. El orden es la recepción en el servidor; no se aceptan fechas del cliente.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Request

This endpoint expects an object.
plugin_eventobjectRequired

Response

Telemetría recibida; no confirma un pago.

pluginenum
Allowed values:
installation_idstring<=255 characters

Identificador estable de la tienda o instalación dentro de la cuenta.

eventenum
Allowed values:
idstring
received_atdatetime

Fecha de recepción del evento en Recurrente.

versionstringOptional<=64 characters

Versión observada por el plugin; omitir si no se conoce.

sitestringOptional<=255 characters
Nombre o dominio de la tienda, sin secretos ni datos de compradores.
error_codeenumOptional

Obligatorio para event=error; recovered indica recuperación reportada.

Allowed values:

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error