Pular para o conteúdo principal
GET
Listar entregas de webhook

Autorizações

x-api-key
string
header
obrigatório

API Key da organização

Parâmetros de consulta

startDate
string<date-time>

Início do período: data e hora ISO 8601 com fuso (ex.: 2026-11-02T00:00:00-03:00). Padrão: 24 horas antes de endDate. Período máximo de 7 dias.

endDate
string<date-time>

Fim do período: data e hora ISO 8601 com fuso. Padrão: agora.

status
enum<string>

Filtra pelo status da entrega: PENDING (na fila), PROCESSING (enviando), SUCCESS (entregue) ou FAILED (tentativas esgotadas).

Opções disponíveis:
PENDING,
PROCESSING,
SUCCESS,
FAILED
event
enum<string>

Evento assinado (valor de value em GET /v1/webhook-event-types, ex.: PIX_IN_PAYED).

Opções disponíveis:
PIX_IN_PAYED,
PIX_IN_REFUNDED,
PIX_OUT_ANALYSIS,
PIX_OUT_PAID,
PIX_OUT_REJECTED,
PIX_OUT_ERROR,
PIX_OUT_REFUNDED,
CHECKOUT_PAID,
CHECKOUT_CANCELED,
CHECKOUT_REJECTED,
CHECKOUT_REFUNDED,
INVOICE_INSTALLMENT_PAID,
INVOICE_INSTALLMENT_CHARGE_FAILED,
INVOICE_INSTALLMENT_OVERDUE,
INVOICE_FULLY_PAID,
INFRACTION_OPENED,
INFRACTION_RESOLVED,
BOLETO_CREATED,
BOLETO_PAID,
BOLETO_CANCELED,
BOLETO_REFUNDED
transactionId
string

Filtra pelas notificações de uma transação (transactionId retornado nas consultas de cobrança, boleto e saque e no payload).

includePayload
enum<string>
padrão:false

true para incluir o corpo JSON enviado em cada entrega (payload). Padrão: false.

Opções disponíveis:
true,
false
page
integer
padrão:1

Página desejada, de 1 a 100.

Intervalo obrigatório: 1 <= x <= 100
limit
integer
padrão:20

Itens por página (1 a 50).

Intervalo obrigatório: 1 <= x <= 50

Resposta

Requisição processada com sucesso

Requisição processada com sucesso

response
object
obrigatório

Dados retornados pela operação; null quando não há conteúdo.

message
string
obrigatório

Mensagem que descreve o resultado.