Pular para o conteúdo principal
GET
List outbound webhooks

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Authorization
string

The authorization token. Important: This header is required only if your environment has the Access Manager plugin enabled.

Parâmetros de consulta

flow_type
string

Required. Outbound flow type. Uppercased server-side. One of: DICT, PAYMENT, COLLECTION, PIX, TRANSFER, REFUND, RECURRING.

Exemplo:

"DICT"

entity_type
string

Filter by internal entity type (e.g. CLAIM, REFUND, INFRACTION_REPORT under DICT; CASHIN, CASHOUT under TRANSFER/REFUND).

Exemplo:

"CLAIM"

entity_id
string

Filter by entity id in UUID format.

Exemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

status
string[]

Filter by status: PENDING, PROCESSING, SENT, FAILED, DEAD_LETTER. Multiple comma-separated values are OR-matched. DEAD_LETTER is a virtual, API-only value that surfaces dead-lettered webhooks.

Exemplo:
request_id
string

Filter by originating request id.

Exemplo:

"560d59b9-3c74-46f8-be67-fee895b8e89e"

created_after
string

Filter rows with created_at >= this RFC3339 timestamp.

Exemplo:

"2026-05-21T12:00:00Z"

created_before
string

Filter rows with created_at <= this RFC3339 timestamp.

Exemplo:

"2026-05-21T12:00:00Z"

limit
string

Items per page (integer 1-100, default 20).

Exemplo:

"20"

page
string

Page number (integer >= 1, default 1).

Exemplo:

"1"

Resposta

OK

items
object[]
obrigatório
limit
integer<int64>
obrigatório
Exemplo:

20

page
integer<int64>
obrigatório
Exemplo:

1

totalItems
integer<int64>
obrigatório
Exemplo:

42