Get All

Obtiene todos los tópicos disponibles para recibir notificaciones y permite filtrarlos por estado activo o paginación.

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

Consultá todos los tópicos disponibles para recibir notificaciones mediante webhooks.

Antes de empezar

  1. Usá este endpoint para conocer qué eventos podés suscribir a tus webhooks.
  2. Si querés limitar el resultado, usá los parámetros de paginación o filtrá por estado activo.
  3. Si necesitás el detalle de un tópico puntual, usá GET /api/notifications/topics/{topic_id}.

Cómo consultar los tópicos disponibles

GET /api/notifications/topics

Consultar con paginación

GET /api/notifications/topics?page=1&per_page=100

Consultar solo tópicos activos

GET /api/notifications/topics?only_active=true

Query parameters

ParámetroTipoRequeridoDefaultDescripción
pageintegerNo1Número de página que querés consultar.
per_pageintegerNo100Cantidad de tópicos por página.
only_activebooleanNotrueSi enviás true, la respuesta incluye solo tópicos activos.

Qué devuelve este endpoint

La respuesta devuelve un arreglo items. Cada elemento representa un tópico disponible para notificaciones.

CampoTipoDescripción
topic_idintegerCódigo identificador del tópico.
namestringNombre del tópico.
event_typestringTipo de evento asociado al tópico.
is_activebooleanIndica si el tópico está activo.

Respuesta esperada

{
  "items": [
    {
      "topic_id": 1,
      "name": "account_statements_update",
      "event_type": "forward_response",
      "is_active": true
    },
    {
      "topic_id": 2,
      "name": "market_order_update",
      "event_type": "forward_response",
      "is_active": true
    }
  ]
}

Cuándo usar este endpoint

Este endpoint es útil cuando necesitás:

  • descubrir los tópicos disponibles para suscripción
  • validar si un tópico sigue activo
  • identificar el topic_id para asociarlo a una configuración de webhook

Errores frecuentes

  • 422 Validation Error: alguno de los query parameters tiene un formato inválido.

Siguiente paso

Después de identificar el tópico que necesitás, consultá su detalle con GET /api/notifications/topics/{topic_id} o revisá la configuración de webhooks con GET /api/notifications/client-hooks.

Query Params
integer
Defaults to 1
integer
Defaults to 100
boolean
Defaults to true
Responses

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