Listar Notificações

Utilize este endpoint para listar notificações de webhook com filtros.

Ambientes Disponíveis

Produção

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

Endpoint

• Método: GET
• Endpoint: /request
• Autenticação: Bearer token

Query Params

ℹ️ Datas em ISO

Os campos startDate e endDate devem ser enviados em ISO date string com horário.

Exemplo:

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

ℹ️ Arrays em query string

Os campos status e tags aceitam múltiplos valores.

Exemplo:

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

Nome	Tipo	Obrigatório	Descrição	Validações
startDate	string	Não	Data inicial do filtro	Deve ser ISO date string com horário
endDate	string	Não	Data final do filtro	Deve ser ISO date string com horário
referenceId	string	Não	ID de referência da notificação	Não pode ser vazio
status	string[] (enum) - RECEIVED, SENT, FAILED, ERROR	Não	Lista de status para filtrar	Deve ser um array não vazio
tags	string[]	Não	Lista de tags para filtrar	Deve ser um array de strings não vazio

Exemplo de Requisição (com todos os 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 seu-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 seu-token-jwt'
  }
});

const data = await response.json();

Resposta de Sucesso

Campo	Tipo	Obrigatório	Descrição
total	number	Sim	Total de itens
totalPages	number	Sim	Total de páginas
currentPage	number	Sim	Página atual
perPage	number	Sim	Itens por página
data	array	Sim	Lista de notificações

Campos do item em data

Campo	Tipo	Obrigatório	Descrição
id	string (UUID)	Sim	Identificador da notificação
referenceId	string	Sim	ID de referência da notificação
url	string	Sim	URL de destino da notificação
status	string (enum) - RECEIVED, SENT, FAILED, ERROR	Sim	Status da notificação
tags	string[]	Sim	Tags associadas à notificação
createdAt	string (ISO)	Sim	Data de criação
userId	string (UUID)	Sim	Identificador do usuário responsável
storeId	string (UUID)	Sim	Identificador da loja

Exemplo de Resposta

{
  "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"
    }
  ]
}

Possíveis Erros

Código	Descrição	Solução
401	Credenciais inválidas	Verifique seu token
403	Sem permissão/autorização	Verifique o escopo do usuário
404	Nenhuma notificação encontrada	Ajuste os filtros da consulta
422	Dados inválidos ou faltando	Verifique o formato dos parâmetros
500	Erro interno	Contate o suporte