Skip to main content

Reenviar Notificações em Massa

Utilize este endpoint para reenvio em massa de notificações de webhook com base em filtros.

Ambientes Disponíveis

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

Endpoint

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

Regras do Body

ℹ️ Regras condicionais

Você deve enviar uma das opções abaixo:

  • startDate + endDate (quando referenceId não for informado)
  • referenceId (quando startDate e endDate não forem informados)

Para cobrir todos os campos do DTO, use os exemplos completos dos dois cenários abaixo.

ℹ️ Datas não podem ser futuras

Os campos startDate e endDate devem ser datas ISO 8601 válidas e não futuras.

Exemplo:

  • 2026-03-24T00:00:00Z
NomeTipoObrigatórioDescriçãoValidações
startDatestring (ISO 8601)CondicionalData inicial para filtroObrigatório quando referenceId não é enviado. Não pode ser futura
endDatestring (ISO 8601)CondicionalData final para filtroObrigatório quando referenceId não é enviado. Não pode ser futura
referenceIdstringCondicionalID de referência de uma notificação específicaObrigatório quando startDate e endDate não são enviados
statusstring[] (enum) - RECEIVED, SENT, FAILED, ERRORNãoLista de status para filtroDeve ser array não vazio
tagsstring[]NãoLista de tags para filtroArray não vazio, no máximo 10 itens
overrideURLstring (URL)NãoURL que substitui a URL atual de destino da notificação no reenvio (para onde a notificação será enviada)Deve ser URL válida

Exemplo de Requisição (cenário startDate + endDate)

curl --request POST \
--url https://api.gateway.com.br/dispatcher/request/resend \
--header 'Authorization: Bearer seu-token-jwt' \
--header 'Content-Type: application/json' \
--data '{
"startDate": "2026-03-23T00:00:00Z",
"endDate": "2026-03-24T23:59:59Z",
"status": ["RECEIVED", "SENT", "FAILED", "ERROR"],
"tags": ["webhook", "notification"],
"overrideURL": "https://api.example.com/webhooks/custom-callback"
}'

Exemplo de Requisição (cenário referenceId)

curl --request POST \
--url https://api.gateway.com.br/dispatcher/request/resend \
--header 'Authorization: Bearer seu-token-jwt' \
--header 'Content-Type: application/json' \
--data '{
"referenceId": "123e4567-e89b-12d3-a456-426614174001",
"status": ["RECEIVED", "SENT", "FAILED", "ERROR"],
"tags": ["webhook", "notification"],
"overrideURL": "https://api.example.com/webhooks/custom-callback"
}'

Resposta de Sucesso

CódigoDescrição
201 CreatedRequisição aceita para processamento de reenvio
ℹ️ Corpo da resposta

Este endpoint retorna 201 e não possui payload de resposta.

Possíveis Erros

CódigoDescriçãoSolução
400Requisição inválidaVerifique formato do body e regras condicionais
401Credenciais inválidasVerifique seu token
403Sem permissão/autorizaçãoVerifique o escopo resend_dispatcher
422Entidade não processávelRevise os campos e validações
500Erro internoContate o suporte