Consulta de mensagens enviadas

Este endpoint possibilita pesquisar todos os eventos enviados pelos webhooks em um determinado período.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O usuário possua uma conta de acesso ao backoffice, fornecida previamente pelo time de integrações.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/WebhookInternal/getAllWebhookMessages

--request POST 'https://sandbox.hiperbanco.com.br/WebhookInternal/getAllWebhookMessages' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Nome	Tipo	Descrição	Especificação
`startDate`	`query`	Obrigatório. Data de inicial das mensagens a serem exibidas na pesquisa (YYYY-DD-MM).	Formato YYYY-MM-DD.
`endDate`	`query`	Obrigatório. Data de final das mensagens a serem exibidas na pesquisa (YYYY-DD-MM).	Formato YYYY-MM-DD.
`state`	`query`	Situação do envio das mensagens. Informe `Success` ou `Failed`. Ao informar Failed, o endpoint retornará todas as mensagens enviadas com sucesso pelo Banco Liquidante, mas que, por alguma falha do lado do parceiro, não foram recebidas por ele.	—
`eventName`	`query`	Nome do evento.	—
`context`	`query`	Contexto em que as mensagens foram enviadas. Exemplo: Pix	—
`page`	`query`	Número da página a ser exibida.	Valor padrão: 1
`pageSize`	`query`	Número de resultados por página.	Valor padrão: 10. Máximo permitido: 100

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

Resposta (Response)

O status code 200 indicará sucesso na consulta.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Campo	Tipo	Descrição
`status`	`number`	Código de status da resposta.
`data`	`object`	Objeto principal com dados da resposta.
`data.data[]`	`array`	Lista de webhooks processados.
`data.data[].id`	`string`	Identificador do processamento. Se necessário, pode ser utilizado para o posterior reprocessamento de mensagens
`data.data[].idempotencyKey`	`string`	Informação utilizada para evitar a duplicidade de transações (valor em formato UUID).
`data.data[].state`	`string`	Estado atual do envio do webhook.
`data.data[].destination`	`string`	URI para qual a mensagem foi enviada.
`data.data[].sentDate`	`string`	Data de envio.
`data.data[].eventName`	`string`	Nome do evento.
`data.data[].retryCount`	`number`	Número de tentativas de reenvio.
`data.data[].elapsedEventCapture`	`string`	Tempo de captura do evento.
`data.data[].elapsedHttpCall`	`string`	Tempo de execução da chamada Http.
`data.data[].context`	`string`	Contexto relacionado ao evento.
`data.links[]`	`array`	Lista de links de navegação da resposta.
`data.links[].url`	`string`	URL de referência para a próxima página.
`data.links[].rel`	`string`	Relação ou tipo de link.
`data.links[].method`	`string`	Método HTTP do link.
`data.meta`	`object`	Objeto com informações de paginação.
`data.meta.page`	`number`	Número da página atual.
`data.meta.pageSize`	`number`	Quantidade de registros por página.
`data.meta.total`	`number`	Total de registros disponíveis.

{
    "status": 200,
    "data": {
        "data": [
            {
                "id": "749f8f5e-2ee5-4245-a5e1-a95d7afbaff4",
                "idempotencyKey": "fd2f8f76-5a42-497e-9a3a-a6d482c190a7",
                "state": "Success",
                "destination": "https://sandbox.hiperbanco.com.br/Webhook/pix/",
                "sentDate": "2025-10-22T19:09:26.57",
                "eventName": "PIX_CASHOUT_WAS_COMPLETED",
                "retryCount": 0,
                "elapsedEventCapture": "00:00:00.1082889",
                "elapsedHttpCall": "00:00:00.2077457",
                "context": "Pix"
            },
            {
                "id": "97614771-607d-4d24-ade0-8580519a83f5",
                "idempotencyKey": "b55405e7-b813-4c3a-8647-7c3482151a4d",
                "state": "Success",
                "destination": "https://sandbox.hiperbanco.com.br/Webhook/pix/",
                "sentDate": "2025-10-22T19:08:56.123",
                "eventName": "PIX_CASH_IN_WAS_CLEARED",
                "retryCount": 0,
                "elapsedEventCapture": "00:00:00.0770356",
                "elapsedHttpCall": "00:00:00.1667271",
                "context": "Pix"
            }
        ],
        "links": [
            {
                "url": "https://webhook.com.br/webhooks?page=2&pageSize=2&startDate=2025-10-22&endDate=2025-10-22&state=Success",
                "rel": "search_next_page_processed_message",
                "method": "GET"
            }
        ],
        "meta": {
            "page": 1,
            "pageSize": 2,
            "total": 30
        }
    }
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.