Get By Id

Obtiene la configuración de un webhook específico mediante su client_hook_id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Consultá la configuración de un webhook específico usando su client_hook_id.

Antes de empezar

  1. Tené a mano el client_hook_id del webhook que querés consultar.
  2. Usá este endpoint cuando necesites validar la URL, el método de autenticación o los tópicos asociados a una configuración puntual.
  3. 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ámetroTipoRequeridoDescripción
client_hook_idintegerSí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.

CampoTipoDescripción
client_hook_idintegerCódigo identificador del webhook.
usernamestringNombre del usuario o identificador asociado al webhook.
webhook_urlstringURL a la que se envían las notificaciones.
authstringMétodo de autenticación configurado.
topicsarray de objetosLista 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.

CampoTipoDescripción
topic_idintegerCó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: el client_hook_id tiene 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.

Path Params
integer
required
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json