Get All

GET https://example.com/api/notifications/client-hooks

Obtiene todas las configuraciones de webhooks disponibles para la integración.

Consultá todas las configuraciones de webhooks disponibles para tu integración.

Antes de empezar

1. Usá este endpoint para revisar qué webhooks ya están configurados.
2. Verificá la URL, el método de autenticación y los tópicos suscritos a cada webhook.
3. Si necesitás el detalle de una configuración puntual, usá GET /api/notifications/client-hooks/{client_hook_id}.

Cómo consultar las configuraciones de webhooks

HTTP

GET /api/notifications/client-hooks

Qué devuelve este endpoint

La respuesta devuelve un arreglo items. Cada elemento representa una configuración de webhook.

Campo	Tipo	Descripción
client_hook_id	integer	Código identificador del webhook.
username	string	Nombre del usuario o identificador asociado al webhook.
webhook_url	string	URL a la que se envían las notificaciones.
auth	string	Método de autenticación configurado.
topics	array de objetos	Lista de tópicos suscritos a ese webhook.

Valores posibles para auth

• bearer: autenticación mediante Bearer Token
• basic: autenticación mediante usuario y contraseña
• header_token: autenticación mediante tokens enviados en headers personalizados

Estructura de topics

Cada elemento dentro de topics representa un tópico suscrito al webhook.

Campo	Tipo	Descripción
topic_id	integer	Código identificador del tópico suscrito.

Respuesta esperada

JSON

{
  "items": [
    {
      "client_hook_id": 10,
      "username": "webhook_user",
      "webhook_url": "https://www.domain.com/webhook/notifications",
      "auth": "bearer",
      "topics": [
        {
          "topic_id": 1
        },
        {
          "topic_id": 2
        }
      ]
    }
  ]
}

Cuándo usar este endpoint

Este endpoint es útil cuando necesitás:

• revisar todas las configuraciones activas de webhooks
• validar qué tópicos están asociados a cada webhook
• identificar el client_hook_id antes de actualizar URL o credenciales

Errores frecuentes

• Si la respuesta no incluye hooks esperados, verificá con el equipo responsable de API Broker que la configuración haya sido creada correctamente.

Siguiente paso

Usá GET /api/notifications/client-hooks/{client_hook_id} para consultar una configuración puntual o PATCH /api/notifications/client-hooks/{client_hook_id} para actualizar la URL del webhook.