Skip to main content
GET
/
webhooks
Listar webhooks
curl --request GET \
  --url https://api.tupana.ai/v1/webhooks \
  --header 'Authorization: <api-key>'
[
  {
    "id": 1,
    "url": "https://mi-sistema.com/webhook",
    "events": [
      "document.issued",
      "document.delivered"
    ],
    "events_display": [
      "Emitido",
      "Entregado"
    ],
    "secret": "mi-clave-secreta",
    "is_active": true,
    "last_status_code": 200,
    "last_sent_at": "2025-01-13T10:30:00Z",
    "success_rate": 95.5,
    "last_delivery": {
      "id": 123,
      "event": "document.issued",
      "is_success": true,
      "status_code": 200,
      "sent_at": "2025-01-13T10:30:00Z",
      "document_id": 456
    },
    "created_at": "2025-01-01T09:00:00Z",
    "updated_at": "2025-01-13T10:30:00Z"
  }
]
Este endpoint permite obtener la lista de webhooks configurados para las entidades accesibles del usuario autenticado. Si se proporciona master_entity_id, filtra solo los webhooks de esa entidad específica.

​
¿Para qué se usa?

Permite obtener la lista de webhooks configurados para las entidades accesibles del usuario. Útil para:
  • Ver todos los webhooks configurados
  • Verificar la configuración de notificaciones
  • Revisar el estado y métricas de entrega de webhooks

​
Qué hace

  • Retorna todos los webhooks de las entidades accesibles del usuario
  • Si se proporciona master_entity_id, filtra solo los webhooks de esa entidad específica
  • Incluye información de eventos configurados, URLs de callback, estado activo/inactivo y métricas de entrega
  • Solo retorna webhooks de entidades a las que el usuario tiene acceso

​
Ejemplos de uso

  • Listar todos los webhooks: Consultar todos los webhooks configurados para todas las entidades accesibles
  • Filtrar por entidad: Obtener solo los webhooks de una entidad específica usando master_entity_id
  • Monitorear estado: Revisar el estado de entrega y tasas de éxito de los webhooks configurados

​
Consideraciones Importantes

​
Acceso a Entidades

Solo se pueden consultar webhooks de entidades a las que el usuario tiene acceso. Si el usuario no tiene entidades accesibles, se retorna una lista vacía.

​
Métricas de Entrega

Cada webhook incluye métricas de entrega como tasa de éxito, último código de estado HTTP, fecha del último envío e información de la última entrega. Esto permite monitorear la salud y confiabilidad de tus webhooks.

Authorizations

​
Authorization
string
header
required

API Key para autenticación. Debe proporcionarse en el header Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo 'Api-Key ' seguido de tu API key)

Query Parameters

​
master_entity_id
integer

ID de la entidad maestra para filtrar webhooks. Opcional. Si no se proporciona, retorna webhooks de todas las entidades accesibles del usuario autenticado.

Response

Lista de webhooks obtenida exitosamente

​
id
integer

ID único del webhook

​
url
string<uri>

URL del endpoint que recibe las notificaciones

​
events
enum<string>[]

Lista de eventos configurados

Available options:
document.issued,
document.delivered,
document.rejected,
document.paid,
document.cancelled
​
events_display
string[]

Nombres legibles de los eventos

Example:
["Emitido", "Entregado", "Rechazado SII"]
​
secret
string | null

Clave secreta para verificar notificaciones

​
is_active
boolean

Si el webhook está activo

​
last_status_code
integer | null

Último código HTTP de respuesta

​
last_sent_at
string<date-time> | null

Fecha de último envío

​
success_rate
number<float>

Tasa de éxito de entregas (0-100)

Required range: 0 <= x <= 100
​
last_delivery
object

Información de la última entrega

​
created_at
string<date-time>

Fecha de creación

​
updated_at
string<date-time>

Fecha de última actualización