Configurar webhook da conta
Configura ou atualiza a URL de webhook para um tipo de evento específico. Se já existir um webhook configurado para o mesmo tipo de evento, ele será atualizado (comportamento de upsert).
Requer token Bearer no header Authorization.
Evento Descrição cash_inPIX recebido cash_outPIX enviado refund_inEstorno de recebimento (devolução solicitada) refund_outDevolução recebida
Campo Tipo Obrigatório Descrição urlstring Sim URL HTTPS do endpoint que receberá os webhooks eventTypestring Sim Tipo de evento: cash_in, cash_out, refund_in, refund_out headersarray Não Headers customizados para autenticação (máximo 5). Headers bloqueados: host, content-length, connection, transfer-encoding, content-type, user-agent headers[].keystring Sim Nome do header headers[].valuestring Sim Valor do header
{
"url" : "https://api.example.com/webhooks/pix" ,
"eventType" : "cash_in" ,
"headers" : [
{ "key" : "Authorization" , "value" : "Bearer token123" },
{ "key" : "X-Webhook-Secret" , "value" : "abc123" }
]
}
Campo Tipo Descrição successboolean Indica se a operação foi bem-sucedida messagestring Mensagem descritiva do resultado
{
"success" : true ,
"message" : "Webhook configurado com sucesso"
}
Status Descrição 400 Dados inválidos (URL não e HTTPS, tipo de evento inválido, etc.) 401 Token não fornecido ou inválido 404 Conta não encontrada 500 Erro interno ao configurar webhook