Buscar Notificação

Utilize este endpoint para buscar os detalhes de uma notificação específica pelo id.

Ambientes Disponíveis

Produção

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

Endpoint

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

Path Params

Nome	Tipo	Obrigatório	Descrição	Validações
id	string	Sim	Identificador da notificação	Deve ser um ID válido de notificação

Exemplo de Requisição

cURL

curl --request GET \
--url https://api.gateway.com.br/dispatcher/request/553e8400-e29b-41d4-a716-446655440000 \
--header 'Authorization: Bearer seu-token-jwt'

JavaScript

const response = await fetch('https://api.gateway.com.br/dispatcher/request/553e8400-e29b-41d4-a716-446655440000', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer seu-token-jwt'
  }
});

const data = await response.json();

Resposta de Sucesso

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	ID da notificação
hash	string	Sim	Hash da notificação
tenant	string	Sim	Tenant da notificação
url	string	Sim	URL de destino da notificação
referenceId	string	Sim	ID de referência
body	object | string	Sim	Payload enviado na notificação
tags	string[]	Sim	Tags da notificação
status	string (enum) - RECEIVED, SENT, FAILED, ERROR	Sim	Status atual da notificação
statusHistory	array	Sim	Histórico de status (ver Sub-Objeto StatusHistory)
createdAt	string (ISO)	Sim	Data de criação
updatedAt	string (ISO)	Sim	Data da última atualização
executions	array	Sim	Execuções da notificação (ver Sub-Objeto Execution)
error	string	Sim	Mensagem de erro da notificação (retorna string vazia quando não houver erro)

Sub-Objetos

StatusHistory (item)

Campo	Tipo	Obrigatório	Descrição
status	string	Sim	Status registrado no histórico
timestamp	string (ISO)	Sim	Data/hora da mudança de status

Execution (item)

Campo	Tipo	Obrigatório	Descrição
url	string	Sim	URL chamada na execução da notificação
headers	object	Não	Headers enviados na execução
createdAt	string (ISO)	Sim	Data/hora da execução
response	object	Sim	Resposta da execução (objeto ResponseVo)
userId	string	Sim	Identificador do usuário relacionado à execução
storeId	string	Sim	Identificador da loja relacionada à execução

Exemplo de Resposta (com todos os campos)

{
  "id": "553e8400-e29b-41d4-a716-446655440000",
  "hash": "ffb2f88d-a863-4a03-bf53-81e7ef73db31",
  "tenant": "splitwave.com.br",
  "url": "https://api.example.com/webhook",
  "referenceId": "123e4567-e89b-12d3-a456-426614174001",
  "body": {
    "event": "PAYMENT_APPROVED",
    "amount": 1000
  },
  "tags": ["webhook", "notification"],
  "status": "RECEIVED",
  "statusHistory": [
    {
      "status": "RECEIVED",
      "timestamp": "2026-03-24T10:00:00.000Z"
    },
    {
      "status": "FAILED",
      "timestamp": "2026-03-24T10:00:01.000Z"
    },
    {
      "status": "SENT",
      "timestamp": "2026-03-24T10:00:05.000Z"
    }
  ],
  "createdAt": "2026-03-24T10:00:00.000Z",
  "updatedAt": "2026-03-24T10:00:05.000Z",
  "executions": [
    {
      "url": "https://api.example.com/webhooks/order-events",
      "headers": {
        "Content-Type": "application/json",
        "X-Splitwave-Signature": "sha256=abcdef123456"
      },
      "createdAt": "2026-03-24T10:00:01.000Z",
      "response": {
        "statusCode": 500,
        "body": "Internal Server Error"
      },
      "userId": "11111111-1111-1111-1111-111111111111",
      "storeId": "22222222-2222-2222-2222-222222222222"
    },
    {
      "url": "https://api.example.com/webhooks/order-events",
      "headers": {
        "Content-Type": "application/json",
        "X-Splitwave-Signature": "sha256=abcdef123456"
      },
      "createdAt": "2026-03-24T10:00:05.000Z",
      "response": {
        "statusCode": 200,
        "body": "ok"
      },
      "userId": "11111111-1111-1111-1111-111111111111",
      "storeId": "22222222-2222-2222-2222-222222222222"
    }
  ],
  "error": "Connection timeout on first attempt"
}

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 get_dispatcher
404	Notificação não encontrada	Verifique o id informado
500	Erro interno	Contate o suporte