Ciabra
Suporte
Webhooks

Eventos e payloads

A plataforma envia quatro tipos de eventos via webhook para os endpoints que você cadastrou. Veja abaixo o payload de cada um e como validar a autenticidade das notificações recebidas.

Validação de autenticidade

Toda notificação enviada pelo Ciabra inclui o header x-ciabra-pub com a chave pública da sua aplicação. Antes de processar qualquer payload, seu sistema deve validar esse header para garantir que a requisição é legítima.

x-ciabra-pub: sua_chave_publica
Header

Tipos de eventos

Estes são os quatro tipos de webhook que a plataforma envia. Cada um possui um payload específico em formato JSON.

Cobrança criada

INVOICE_CREATED

Disparado sempre que uma nova cobrança é criada na plataforma.

{
  "id": "invoice_id",
  "externalId": "seu_id_externo",
  "type": "INVOICE_CREATE"
}
Payload

Cobrança deletada

INVOICE_DELETED

Disparado quando uma parcela de uma cobrança é deletada.

{
  "id": "installment_id",
  "externalId": "seu_id_externo",
  "type": "INVOICE_DELETE_INSTALLMENT"
}
Payload

Pagamento gerado

PAYMENT_GENERATED

Disparado quando o meio de pagamento é gerado e está disponível para o pagador. O payload varia conforme o tipo: PIX traz o campo emv (código copia e cola), Boleto traz o campo url (link do PDF).

{
  "id": "invoice_id",
  "installmentId": "installment_id",
  "externalId": "seu_id_externo",
  "emv": "<código copia e cola do PIX, presente se o pagamento for PIX>",
  "url": "<URL do PDF do boleto, presente se o pagamento for BOLETO>",
  "type": "PAYMENT_GENERATED"
}
Payload

Pagamento confirmado

PAYMENT_CONFIRMED

Disparado quando um pagamento é confirmado e creditado na conta.

{
  "id": "invoice_id",
  "installmentId": "installment_id",
  "type": "INVOICE_PAYMENT_CONFIRMED",
  "pricePaid": 15000,
  "fee": 150,
  "externalId": "seu_id_externo"
}
Payload
Cadastrar webhook