Kuenta Docs

Appearance

Listar webhooks configurados​

GET
/webhooks

Obtiene la lista de webhooks configurados para la organización.

Uso

Este endpoint permite consultar todos los webhooks que han sido configurados para recibir notificaciones de eventos del sistema.

Permisos requeridos

  • ReadWebhook: Lectura de configuración de webhooks

Authorizations​

bearerAuth

JWT token de autenticación. Utilice este esquema para autenticar solicitudes con un token JWT.

TypeHTTP (bearer)

Parameters​

Header Parameters

Config-Organization-ID*

ID único de la organización para la cual se consultan los webhooks.

Formato: UUID v4
Validación: Debe corresponder a una organización activa

Typestring
Required
Example123e4567-e89b-12d3-a456-426614174000
formatuuid
Organization-ID*

ID de la organización (campo legacy, usar Config-Organization-ID preferentemente).

Nota: En futuras versiones este header será deprecado.

Typestring
Required
Example123e4567-e89b-12d3-a456-426614174000
formatuuid

Query Parameters

status

Filtrar por estado del webhook.

Estados:

  • active: Solo webhooks activos
  • inactive: Solo webhooks inactivos
  • failed: Solo webhooks con fallos recientes
Typestring
Enum
activeinactivefailed
Exampleactive
event

Filtrar por tipo de evento suscrito.

Eventos disponibles:

  • credit.created: Crédito creado
  • credit.approved: Crédito aprobado
  • credit.rejected: Crédito rechazado
  • credit.disbursed: Crédito desembolsado
  • payment.received: Pago recibido
  • payment.failed: Pago fallido
  • document.signed: Documento firmado
  • analysis.completed: Análisis completado
Typestring
Enum
credit.createdcredit.approvedcredit.rejectedcredit.disbursedpayment.receivedpayment.faileddocument.signedanalysis.completed
Examplecredit.approved
limit

Número máximo de webhooks a retornar.

Typeinteger
Example10
minimum1
maximum100
default20
offset

Número de webhooks a omitir (para paginación).

Typeinteger
Example0
minimum0
default0
before

Filtrar por fecha de creación del webhook.

Formato: ISO 8601

Typestring
Example2023-12-01T15:30:00Z
formatdate-time

Responses​

Lista de webhooks obtenida exitosamente
application/json
JSON
{
"message": "webhooks",
"data": [
{
"ID": "123e4567-e89b-12d3-a456-426614174000",
"name": "Notificaciones de Crédito",
"url": "https://api.miempresa.com/webhooks/kuenta/credits",
"events": [
"credit.approved",
"credit.rejected",
"credit.disbursed"
],
"status": "active",
"lastTriggered": "2023-12-01T15:30:00Z",
"successRate": 0.98,
"totalCalls": 1250,
"createdAt": "2023-10-01T10:00:00Z",
"updatedAt": "2023-11-15T14:20:00Z"
},
{
"ID": "234e5678-e89b-12d3-a456-426614174001",
"name": "Notificaciones de Pago",
"url": "https://api.miempresa.com/webhooks/kuenta/payments",
"events": [
"payment.received",
"payment.failed"
],
"status": "active",
"lastTriggered": "2023-12-01T16:45:00Z",
"successRate": 1,
"totalCalls": 892,
"createdAt": "2023-10-15T09:30:00Z",
"updatedAt": "2023-11-20T11:15:00Z"
}
],
"meta": {
"total": 2,
"page": 1,
"per_page": 20,
"total_pages": 1
}
}

Playground​

Server
Authorization
Headers
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI