> ## Documentation Index
> Fetch the complete documentation index at: https://documentacao.parcelemais.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Listar auditoria de webhooks
> Retorna, de forma paginada, os envios de webhook feitos ao parceiro identificado pelo token de acesso, com a requisição enviada, a resposta recebida e o status HTTP. Ordenado do mais recente para o mais antigo.
Retorna o histórico de envios de webhook feitos para o seu endpoint: uma linha por tentativa, com a requisição enviada, a resposta recebida e o status HTTP.
Cada tentativa de envio gera um registro, mesmo quando seu endpoint responde com erro ou está fora do ar. Use o filtro `statusCode` para localizar envios que falharam.
Consulte os valores possíveis de `tipo` em [Listar webhooks](/pages/webhooks/list).
## OpenAPI
````yaml GET /v1/webhooks/auditoria
openapi: 3.0.1
info:
title: WebIntegration
description: Este documento descreve os endpoints disponíveis da API.
version: '1.0'
servers:
- url: https://api.parcelemais.com.br/integration
description: Servidor para o ambiente de produção
- url: https://api.staging.parcelemais.com.br/integration
description: Servidor para o ambiente de staging
security:
- bearerAuth: []
paths:
/v1/webhooks/auditoria:
get:
tags:
- Webhook
summary: Listar auditoria de webhooks.
description: >-
Retorna, de forma paginada, os envios de webhook feitos ao parceiro
identificado pelo token de acesso, com a requisição enviada, a resposta
recebida e o status HTTP. Ordenado do mais recente para o mais antigo.
operationId: pagedAuditWebHooks
parameters:
- name: dataInicio
in: query
description: Data de início do filtro no formato ISO-8601. Campo opcional.
schema:
type: string
format: date-time
example: '2025-01-01T00:00:00-03:00'
example: '2025-01-01T00:00:00-03:00'
- name: dataFim
in: query
description: Data de fim do filtro no formato ISO-8601. Campo opcional.
schema:
type: string
format: date-time
example: '2025-12-31T23:59:59-03:00'
example: '2025-12-31T23:59:59-03:00'
- name: pedidoId
in: query
description: Identificador do pedido. Campo opcional.
schema:
type: string
format: uuid
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
- name: numeroPedido
in: query
description: Número do pedido. Campo opcional.
schema:
type: integer
format: int64
example: 1001
example: 1001
- name: statusCode
in: query
description: Status HTTP retornado pelo webhook do parceiro. Campo opcional.
schema:
type: integer
format: int32
minimum: 100
maximum: 599
example: 200
example: 200
- name: pagina
in: query
description: 'Número da página. Padrão: 1.'
schema:
type: integer
format: int32
example: 1
example: 1
- name: tamanhoPagina
in: query
description: 'Quantidade de itens por página. Padrão: 10.'
schema:
type: integer
format: int32
example: 10
example: 10
responses:
'200':
description: Auditoria retornada com sucesso.
content:
application/json:
schema:
$ref: >-
#/components/schemas/Core.Domain.Primitives.IPagedResult_AuditWebHookIntegrationResponse
example:
itens:
- id: 3c90c3cc-0d44-4b50-8888-8dd25736052a
tipo: 3
requisicao: >-
{"id_pedido":"3c90c3cc-0d44-4b50-8888-8dd25736052a","enum_status":2,"status":"Approved"}
resposta: '{"message":"ok"}'
statusCode: 200
dataCriacao: '2025-01-15T10:30:00-03:00'
pagina:
tem_proximo: false
tem_anterior: false
numero: 1
tamanho: 10
total: 1
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
'404':
description: Parceiro não encontrado.
'500':
description: Internal Server Error
components:
schemas:
Core.Domain.Primitives.IPagedResult_AuditWebHookIntegrationResponse:
type: object
properties:
itens:
type: array
items:
$ref: >-
#/components/schemas/Integration.Shared.Responses.WebHook.AuditWebHookIntegrationResponse
readOnly: true
pagina:
$ref: '#/components/schemas/Core.Domain.Primitives.Pagina'
additionalProperties: false
Microsoft.AspNetCore.Mvc.ProblemDetails:
type: object
properties:
tipo:
type: string
nullable: true
titulo:
type: string
nullable: true
status:
type: integer
format: int32
nullable: true
detalhe:
type: string
nullable: true
instancia:
type: string
nullable: true
erros:
type: object
nullable: true
description: >-
Detalhamento por campo, presente quando o erro é de validação de
payload. Ausente (`null`) para erros de regra de negócio, que trazem
a explicação apenas em `detalhe`.
additionalProperties:
type: array
items:
type: string
correlationId:
type: string
nullable: true
description: >-
Identificador de correlação da requisição (ver cabeçalho
`CorrelationId`), útil para localizar logs ao abrir um chamado de
suporte.
example:
tipo: https://tools.ietf.org/html/rfc7231#section-6.5.1
titulo: Requisição inválida.
status: 400
detalhe: O campo 'cpf' é obrigatório.
instancia: /v1/order
erros:
cpf:
- O campo 'cpf' é obrigatório.
correlationId: 0HN7E4B8Q9K3D:00000001
Integration.Shared.Responses.WebHook.AuditWebHookIntegrationResponse:
type: object
properties:
id:
type: string
format: uuid
tipo:
type: integer
format: int32
enum:
- 1
- 2
- 3
description: >-
1: Cliente (fluxo em roadmap); 2: Simulação (fluxo em roadmap); 3:
Pedido (envio disponível).
requisicao:
type: string
description: Corpo da requisição enviada ao seu endpoint, como texto.
resposta:
type: string
description: Corpo da resposta recebida do seu endpoint, como texto.
statusCode:
type: integer
format: int32
description: Status HTTP retornado pelo seu endpoint.
dataCriacao:
type: string
format: date-time
additionalProperties: false
Core.Domain.Primitives.Pagina:
type: object
properties:
tem_proximo:
type: boolean
tem_anterior:
type: boolean
numero:
type: integer
format: int32
tamanho:
type: integer
format: int32
total:
type: integer
format: int32
additionalProperties: false
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Cabeçalho de autenticação Bearer no formato `Bearer ` onde
`` é seu TOKEN de autenticação
````