Skip to content

Visao Geral ​

Receba notificacoes em tempo real sobre eventos da sua conta.

O que sao Webhooks ​

Webhooks permitem que sua aplicacao receba notificacoes HTTP automaticas quando eventos importantes acontecem na sua conta Pix2bit. Em vez de fazer polling periodico na API, voce configura uma URL e o Pix2bit envia um POST com os dados do evento.

Como funciona ​

  1. Voce registra uma URL de webhook no painel ou via API
  2. Quando um evento acontece (ex: deposito confirmado), o Pix2bit envia um POST para sua URL
  3. Sua aplicacao processa a notificacao e retorna HTTP 2xx

Formato da notificacao ​

Todas as notificacoes seguem o mesmo formato:

json
{
  "event": "DEPOSIT_ASSET_SUCCESS",
  "data": {
    "success": true,
    "transactionId": "67a1b2c3d4e5f67890abcdef",
    "chargeId": "67a1b2c3d4e5f67890abcde0",
    "value": 5000,
    "creditedValue": 4950,
    "fee": 50,
    "providerId": "eulen-charge-id-123"
  }
}
CampoDescricao
eventNome do evento que disparou o webhook
dataDados especificos do evento

Headers enviados ​

Cada requisicao de webhook inclui os seguintes headers:

HeaderValorEditavel
Acceptapplication/jsonNao
Content-Typeapplication/jsonNao
X-Pix2bit-SignatureAssinatura da requisicaoNao
AuthorizationSeu valor customizadoSim

TIP

Use o header Authorization para validar que a requisicao veio do Pix2bit. Configure um token secreto ao criar o webhook.

Eventos disponiveis ​

EventoDescricao
DEPOSIT_ASSET_SUCCESSDeposito PIX confirmado com sucesso
PAYOUT_SUCCESSFULPagamento/saque realizado com sucesso
PAYOUT_FAILEDPagamento/saque falhou

Consulte a pagina de Eventos para detalhes sobre o payload de cada evento.

Confiabilidade ​

  • Todas as entregas de webhook sao registradas com status code e response body
  • Em caso de falha (status code fora do range 2xx), o Pix2bit registra o erro
  • Voce pode verificar os logs de entrega no painel