get
https://example.com/api/notifications/client-hooks/
Obtiene la configuración de un webhook específico mediante su client_hook_id.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Consultá la configuración de un webhook específico usando su client_hook_id.
Antes de empezar
- Tené a mano el
client_hook_iddel webhook que querés consultar. - Usá este endpoint cuando necesites validar la URL, el método de autenticación o los tópicos asociados a una configuración puntual.
- Si todavía no conocés el identificador del webhook, obtenelo primero con
GET /api/notifications/client-hooks.
Cómo consultar un webhook
GET /api/notifications/client-hooks/{client_hook_id}Path parameters
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
client_hook_id | integer | Sí | Código identificador del webhook que querés consultar. |
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
authbearer: autenticación mediante Bearer Tokenbasic: autenticación mediante usuario y contraseñaheader_token: autenticación mediante tokens enviados en headers personalizados
Estructura de topics
topicsCada 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
{
"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:
- validar una configuración puntual de webhook
- revisar qué tópicos están asociados a un
client_hook_id - confirmar la URL y el método de autenticación antes de actualizarlo
Errores frecuentes
422 Validation Error: elclient_hook_idtiene un formato inválido.
Siguiente paso
Si necesitás actualizar la URL del webhook, usá PATCH /api/notifications/client-hooks/{client_hook_id}. Si necesitás actualizar credenciales, usá PATCH /api/notifications/client-hooks/{client_hook_id}/credentials.
