Fire Bankingdocs

Configurar webhook de la cuenta

POST /api/webhooks

Configura o actualiza la URL del webhook para un tipo de evento específico. Si ya existe un webhook para el mismo tipo de evento, se actualizará (comportamiento upsert).

Autenticación

Requiere un Bearer token en el header Authorization.

Eventos disponibles

EventoDescripción
cash_inPIX recibido
cash_outPIX enviado
refund_inReembolso de pago recibido (reembolso solicitado)
refund_outReembolso recibido

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
urlstringURL HTTPS del endpoint que recibirá los webhooks
eventTypestringTipo de evento: cash_in, cash_out, refund_in, refund_out
headersarrayNoHeaders personalizados para autenticación (máximo 5). Headers bloqueados: host, content-length, connection, transfer-encoding, content-type, user-agent
headers[].keystringNombre del header
headers[].valuestringValor del header
{
  "url": "https://api.example.com/webhooks/pix",
  "eventType": "cash_in",
  "headers": [
    { "key": "Authorization", "value": "Bearer token123" },
    { "key": "X-Webhook-Secret", "value": "abc123" }
  ]
}

Respuesta (200)

CampoTipoDescripción
successbooleanIndica si la operación fue exitosa
messagestringMensaje descriptivo del resultado
{
  "success": true,
  "message": "Webhook configurado com sucesso"
}

Errores

EstadoDescripción
400Datos inválidos (la URL no es HTTPS, tipo de evento inválido, etc.)
401Token faltante o inválido
404Cuenta no encontrada
500Error interno al configurar el webhook

En esta página