Pular para o conteúdo principal
POST
/
api
/
webhooks
Configurar webhook da conta
curl --request POST \
  --url https://api.public.firebanking.com.br/api/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://api.example.com/webhooks/pix",
  "eventType": "cash_in",
  "headers": [
    {
      "key": "Authorization",
      "value": "Bearer token123"
    },
    {
      "key": "X-Webhook-Secret",
      "value": "abc123"
    }
  ]
}
'
{
  "success": true,
  "message": "Webhook configurado com sucesso"
}

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:
[
  {
    "key": "Authorization",
    "value": "Bearer token123"
  },
  {
    "key": "X-Webhook-Secret",
    "value": "abc123"
  }
]

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"