Skip to main content
GET
Listar webhooks de saída

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

flow_type
enum<string>

Obrigatório. Tipo de fluxo de saída. Convertido para maiúsculas no servidor.

Opções disponíveis:
DICT,
PAYMENT,
COLLECTION,
PIX,
TRANSFER,
REFUND,
RECURRING
entity_type
string

Filtrar por tipo de entidade interno. Exemplos: CLAIM, REFUND, INFRACTION_REPORT sob flow_type=DICT; CASHIN, CASHOUT sob flow_type=TRANSFER ou REFUND.

entity_id
string

Filtrar por id de entidade no formato UUID

status
enum<string>

Filtrar por status. DEAD_LETTER é um valor virtual, exclusivo da API, que expõe webhooks em dead-letter.

Opções disponíveis:
PENDING,
PROCESSING,
SENT,
FAILED,
DEAD_LETTER
request_id
string

Filtrar pelo id da requisição de origem

created_after
string

Filtrar registros com created_at >= esta data/hora RFC3339

created_before
string

Filtrar registros com created_at <= esta data/hora RFC3339

limit
integer
padrão:10

Número máximo de itens por página.

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

Número da página para paginação.

Intervalo obrigatório: x >= 1

Resposta

OK

items
object[]
limit
integer
Exemplo:

20

page
integer
Exemplo:

1

totalItems
integer
Exemplo:

42