Listar Notificaciones

Utilice este endpoint para listar notificaciones de webhook con filtros.

Entornos Disponibles

Producción

https://api.gateway.com.br/dispatcher

Endpoint

• Método: GET
• Endpoint: /request
• Autenticación: Bearer token

Query Params

ℹ️ Fechas en ISO

Los campos startDate y endDate deben enviarse como ISO date string con hora.

Ejemplo:

• 2026-03-24T12:00:00.000Z

ℹ️ Arreglos en el query string

Los campos status y tags aceptan múltiples valores.

Ejemplo:

• status=SENT&status=FAILED
• tags=PAID&tags=CANCELLED

Nombre	Tipo	Obligatorio	Descripción	Validaciones
startDate	string	No	Fecha inicial del filtro	Debe ser una ISO date string con hora
endDate	string	No	Fecha final del filtro	Debe ser una ISO date string con hora
referenceId	string	No	ID de referencia de la notificación	No puede estar vacío
status	string[] (enum) - RECEIVED, SENT, FAILED, ERROR	No	Lista de estados para filtrar	Debe ser un arreglo no vacío
tags	string[]	No	Lista de etiquetas para filtrar	Debe ser un arreglo de strings no vacío

Ejemplo de Solicitud (con todos los campos)

cURL

curl --request GET \
--url "https://api.gateway.com.br/dispatcher/request?startDate=2026-03-01T00:00:00.000Z&endDate=2026-03-24T23:59:59.999Z&referenceId=6d66e879-0345-44c9-9146-3cfc81842684&status=RECEIVED&status=SENT&status=FAILED&status=ERROR&tags=PAID&tags=CANCELLED" \
--header 'Authorization: Bearer su-token-jwt'

JavaScript

const params = new URLSearchParams({
  startDate: '2026-03-01T00:00:00.000Z',
  endDate: '2026-03-24T23:59:59.999Z',
  referenceId: '6d66e879-0345-44c9-9146-3cfc81842684'
});

params.append('status', 'RECEIVED');
params.append('status', 'SENT');
params.append('status', 'FAILED');
params.append('status', 'ERROR');
params.append('tags', 'PAID');
params.append('tags', 'CANCELLED');

const response = await fetch(`https://api.gateway.com.br/dispatcher/request?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer su-token-jwt'
  }
});

const data = await response.json();

Respuesta Exitosa

Campo	Tipo	Obligatorio	Descripción
total	number	Sí	Total de elementos
totalPages	number	Sí	Total de páginas
currentPage	number	Sí	Página actual
perPage	number	Sí	Elementos por página
data	array	Sí	Lista de notificaciones

Campos del elemento en data

Campo	Tipo	Obligatorio	Descripción
id	string (UUID)	Sí	Identificador de la notificación
referenceId	string	Sí	ID de referencia de la notificación
url	string	Sí	URL de destino de la notificación
status	string (enum) - RECEIVED, SENT, FAILED, ERROR	Sí	Estado de la notificación
tags	string[]	Sí	Etiquetas asociadas a la notificación
createdAt	string (ISO)	Sí	Fecha de creación
userId	string (UUID)	Sí	Identificador del usuario responsable
storeId	string (UUID)	Sí	Identificador de la tienda

Ejemplo de Respuesta

{
  "total": 2,
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 10,
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-446655440000",
      "referenceId": "6d66e879-0345-44c9-9146-3cfc81842684",
      "url": "https://api.example.com/webhooks/order-events",
      "status": "SENT",
      "tags": ["PAID", "CANCELLED"],
      "createdAt": "2026-03-24T10:00:00.000Z",
      "userId": "11111111-1111-1111-1111-111111111111",
      "storeId": "22222222-2222-2222-2222-222222222222"
    },
    {
      "id": "663e8400-e29b-41d4-a716-446655440001",
      "referenceId": "4ef9706d-5ea3-4f07-b282-c6be9ac83c9b",
      "url": "https://api.example.com/webhooks/billing-events",
      "status": "FAILED",
      "tags": ["CANCELLED", "webhook"],
      "createdAt": "2026-03-24T11:00:00.000Z",
      "userId": "33333333-3333-3333-3333-333333333333",
      "storeId": "44444444-4444-4444-4444-444444444444"
    }
  ]
}

Errores Posibles

Código	Descripción	Solución
401	Credenciales inválidas	Verifique su token
403	Sin permiso/autorización	Verifique el alcance del usuario
404	No se encontró ninguna notificación	Ajuste los filtros de la consulta
422	Datos inválidos o faltantes	Verifique el formato de los parámetros
500	Error interno	Contacte al soporte