Fire Bankingdocs

Configurar webhook da conta

POST /api/webhooks

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).

Autenticação

Requer token Bearer no header Authorization.

Eventos Disponíveis

EventoDescrição
cash_inPIX recebido
cash_outPIX enviado
refund_inEstorno de recebimento (devolução solicitada)
refund_outDevolução recebida

Request Body

CampoTipoObrigatórioDescrição
urlstringSimURL HTTPS do endpoint que receberá os webhooks
eventTypestringSimTipo de evento: cash_in, cash_out, refund_in, refund_out
headersarrayNãoHeaders customizados para autenticação (máximo 5). Headers bloqueados: host, content-length, connection, transfer-encoding, content-type, user-agent
headers[].keystringSimNome do header
headers[].valuestringSimValor do header
{
  "url": "https://api.example.com/webhooks/pix",
  "eventType": "cash_in",
  "headers": [
    { "key": "Authorization", "value": "Bearer token123" },
    { "key": "X-Webhook-Secret", "value": "abc123" }
  ]
}

Response (200)

CampoTipoDescrição
successbooleanIndica se a operação foi bem-sucedida
messagestringMensagem descritiva do resultado
{
  "success": true,
  "message": "Webhook configurado com sucesso"
}

Erros

StatusDescrição
400Dados inválidos (URL não e HTTPS, tipo de evento inválido, etc.)
401Token não fornecido ou inválido
404Conta não encontrada
500Erro interno ao configurar webhook

Nesta página