Manual do Dev
InstitucionalBlogService DeskStatus Page

Consulta de mensagens enviadas

beta scopes: webhook.read

Suggest Edits

É possível pesquisar todos os eventos enviados pelos webhooks em um determinado período.

🚧

Importante

Recomendamos que o parceiro estabeleça uma rotina de consulta de mensagens enviadas para que identifique eventuais falhas no recebimento de eventos e, dessa forma, possa solicitar o reprocessamento de mensagens.

Etapas

Endpoint

Para consumo desse endpoint, preencha os seguintes campos obrigatórios no path da requisição:

  • startDate: data de inicial das mensagens a serem exibidas na pesquisa (YYYY-DD-MM);
  • endDate: data de final das mensagens a serem exibidas (YYYY-DD-MM).

🚧

Importante

O startDate deve ser preenchido com uma data no máximo seis meses anterior à data atual.

Opcionalmente, para mais detalhes, informe:

  • state: nesse campo, é possível informar Success ou Failed. Ao informar Failed, o endpoint retornará todas as mensagens enviadas com sucesso pelo Bankly, mas que, por alguma falha do lado do parceiro, não foram recebidas por ele;
  • eventName: nome do evento;
  • context: contexto em que os eventos foram enviados. Exemplo: Pix;
  • page: número da página que deseja consultar;
  • pageSize: quantidade de resultados a serem exibidos por página. 
--location --request  GET 'https://api-mtls.sandbox.bankly.com.br/webhooks/processed-messages?startDate=2021-11-21&endDate=2021-11-21&state=Success&eventName=PIX_CASH_IN_WAS_RECEIVED&context=Pix&page=1&pageSize=100' \  
--header 'Content-Type: application/json' \  
--header 'Authorization: Bearer [token]' \

Retorno

O retorno da requisição trará os seguintes campos:

  • idempotencyKey: informação utilizada para evitar a duplicidade de transações (valor em formato UUID). Esse valor poderá ser utilizado para o posterior reprocessamento de mensagens, caso seja necessário;
  • state: informa se a mensagem foi recebida com sucesso (Success) ou se houve falha no recebimento (Failed);
  • destination: URI para qual a mensagem foi enviada;
  • sentDate: data de envio;
  • eventName: nome do evento;
  • retryCount: número de tentativas de reenvio;
  • elapsedEventCapture: tempo de captura do evento;
  • elapsedHttpCall: tempo de execução da chamada Http;
  • context: contexto do evento. 
{
   "data": [
      {
         "idempotencyKey": "498dfed0-e994-49cb-a33b-7bd8088c4d8e",
         "state": "Success",
         "destination": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d6",
         "sentDate": "2021-11-21T16:47:27.14",
         "eventName": "PIX_CASH_IN_WAS_RECEIVED",
         "retryCount": 0,
         "elapsedEventCapture": "00:00:00.0996311",
         "elapsedHttpCall": "00:00:00.6384607",
         "context": "Pix"
      },
      {
         "idempotencyKey": "7697d191-429e-4400-955e-a115926bb38a",
         "state": "Success",
         "destination": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d6",
         "sentDate": "2021-11-21T16:49:05.287",
         "eventName": "PIX_CASH_IN_WAS_RECEIVED",
         "retryCount": 0,
         "elapsedEventCapture": "00:00:00.1029727",
         "elapsedHttpCall": "00:00:00.6287861",
         "context": "Pix"
      },
      {
         "idempotencyKey": "8fa77d00-2551-4ec3-ba1c-49ec65085bd7",
         "state": "Success",
         "destination": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d6",
         "sentDate": "2021-11-21T16:49:05.733",
         "eventName": "PIX_CASH_IN_WAS_RECEIVED",
         "retryCount": 0,
         "elapsedEventCapture": "00:00:00.1030878",
         "elapsedHttpCall": "00:00:00.5653400",
         "context": "Pix"
      }
   ],
   "links": [
      {
         "url": "https://api.sandbox.bankly.com.br/webhooks?page=2&pageSize=100&startDate=2021-11-21&endDate=2021-11-21&state=Success&eventName=PIX_CASH_IN_WAS_RECEIVED&context=Pix",
         "rel": "search_next_page_processed_message",
         "method": "GET"
      }
   ],
   "meta": {
      "page": 1,
      "pageSize": 3,
      "total": 10
   }
}

Updated 11 months ago