Skip to main content
POST
Configurar webhook da conta

Autorizações

Authorization
string
header
obrigatório

Enter JWT token

Corpo

application/json
url
string<uri>
obrigatório

URL HTTPS do endpoint que receberá os webhooks. Deve usar protocolo HTTPS.

Exemplo:

"https://api.example.com/webhooks/pix"

eventType
enum<string>
obrigatório

Tipo de evento para receber notificações

Opções disponíveis:
cash_in,
cash_out,
refund_in,
refund_out
Exemplo:

"cash_in"

headers
object[]

Headers customizados para autenticação (máximo 5). Headers bloqueados: host, content-length, connection, transfer-encoding, content-type, user-agent

Maximum array length: 5
Exemplo:

Resposta

Webhook configurado com sucesso

success
boolean
obrigatório

Indica se a operação foi bem-sucedida

Exemplo:

true

message
string
obrigatório

Mensagem descritiva do resultado

Exemplo:

"Webhook configurado com sucesso"