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
GETQuery Parameters
Parâmetro | Tipo | Descrição |
---|---|---|
event_type | string | Tipo do evento (ex: "debt_disbursed") |
callback_status | string | Status do callback (ex: "failed", "sent", etc.) |
origin_key | uuid | Chave única da origem do evento |
start_datetime | string | Data/hora inicial no formato "YYYY-MM-DDTHH:mm:ssZ" (Fuso Horário UTC) |
end_datetime | string | Data/hora final no formato "YYYY-MM-DDTHH:mm:ssZ" (Fuso Horário UTC) |
Observação: A janela de tempo entre
start_datetime
eend_datetime
deve ser no máximo 14 dias. Caso contrário, será retornado um erro.
Response
STATUS
200Response 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âmetro | Tipo | Descrição |
---|---|---|
event_key | uuid | Chave única do evento |
event_type | string | Tipo do evento (ex: "debt_disbursed") |
status | string | Status do evento (ex: "processed") |
origin_enumerator | string | API de origem do evento (ex: "lego") |
origin_key | uuid | Chave única do recurso da API de origem |
callbacks | list | Lista de objetos Callback |
pagination | object | Objeto Pagination |
Callback Object
Parâmetro | Tipo | Descrição |
---|---|---|
callback_key | uuid | Chave única do callback |
callback_status | string | Status do callback (ex: "failed", "sent", etc.) |
Pagination Object
Parâmetro | Tipo | Descrição |
---|---|---|
current_page | integer | Número da página atual |
rows_per_page | integer | Quantidade de registros por página |
STATUS
400Response 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
PATCHPath Parameters
Parâmetro | Tipo | Descrição |
---|---|---|
event_key | uuid | Chave única do evento (obtida na listagem) |
callback_key | uuid | Chave ú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
204Response 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:
- Verifique se o
event_key
ecallback_key
estão corretos. - Confirme se o callback existe.
- Verifique se a janela de tempo está dentro do limite de 14 dias.
- Em caso de erro persistente, entre em contato com o suporte técnico.