Pular para o conteúdo principal

Reenvio de Notificações

Aqui demonstramos como realizar o reenvio de callbacks de webhooks no sistema. O reenvio pode ser realizado para qualquer callback, independentemente do seu status atual.

Listando eventos elegíveis para reenvio

Request

ENDPOINT
/notification/events
MÉTODO
GET

Query Parameters

ParâmetroTipoDescrição
event_typestringTipo do evento (ex: "debt_disbursed")
callback_statusstringStatus do callback (ex: "failed", "sent", etc.)
origin_keyuuidChave única da origem do evento
start_datetimestringData/hora inicial no formato "YYYY-MM-DDTHH:mm:ssZ" (Fuso Horário UTC)
end_datetimestringData/hora final no formato "YYYY-MM-DDTHH:mm:ssZ" (Fuso Horário UTC)

Observação: A janela de tempo entre start_datetime e end_datetime deve ser no máximo 14 dias. Caso contrário, será retornado um erro.

Response

STATUS
200
Response Body
{
"data": [
{
"event_key": "<UUID>",
"event_type": "debt_disbursed",
"status": "processed",
"origin_enumerator": "account",
"origin_key": "<UUID>",
"callbacks": [
{
"callback_key": "<UUID>",
"callback_status": "failed"
}
],
}
],
"pagination": {
"current_page": 1,
"rows_per_page": 25,
}
}

Response Parameters

ParâmetroTipoDescrição
event_keyuuidChave única do evento
event_typestringTipo do evento (ex: "debt_disbursed")
statusstringStatus do evento (ex: "processed")
origin_enumeratorstringAPI de origem do evento (ex: "lego")
origin_keyuuidChave única do recurso da API de origem
callbackslistLista de objetos Callback
paginationobjectObjeto Pagination

Callback Object

ParâmetroTipoDescrição
callback_keyuuidChave única do callback
callback_statusstringStatus do callback (ex: "failed", "sent", etc.)

Pagination Object

ParâmetroTipoDescrição
current_pageintegerNúmero da página atual
rows_per_pageintegerQuantidade de registros por página
STATUS
400
Response Body: Error
{
"code": "PMB000032",
"title": "Bad Request",
"description": "Selected timeframe should have a maximum of 14 days",
"translation": "O intervalo de tempo selecionado deve ter no máximo 14 dias",
}

Reenviando um callback

Request

ENDPOINT
/notification/event/{event_key}/callback/{callback_key}/retry
MÉTODO
PATCH

Path Parameters

ParâmetroTipoDescrição
event_keyuuidChave única do evento (obtida na listagem)
callback_keyuuidChave única do callback (obtida na listagem)
Exemplo de Uso
curl -X PATCH "https://api-auth.sandbox.qitech.app/notification/event/123e4567-e89b-12d3-a456-426614174000/callback/987fcdeb-51a2-43d7-9012-345678901234/retry"

Response

STATUS
204
Response Body
{}

Observações Importantes

  • O reenvio é exclusivo para callbacks de webhooks.
  • A janela de tempo para busca de eventos é limitada a 14 dias.

Troubleshooting

Em caso de problemas com o reenvio de callbacks:

  1. Verifique se o event_key e callback_key estão corretos.
  2. Confirme se o callback existe.
  3. Verifique se a janela de tempo está dentro do limite de 14 dias.
  4. Em caso de erro persistente, entre em contato com o suporte técnico.