Docs Entrar na plataforma

Webhooks

Catálogo de eventos

Todos os tipos de evento, quando cada um é enviado e o formato do data de cada família.

Pré-autorização

Tipo Quando
pre_authorization.created Pré-autorização criada Uma pré-autorização foi criada — pela API, pela plataforma, por importação ou automaticamente. Status IN_PRE_AUTH.
pre_authorization.declined Pré-autorização recusada pelo fornecedor O fornecedor recusou a oferta. Status REPROVED.
pre_authorization.revoked Pré-autorização cancelada A pré-autorização foi cancelada pela sua empresa (API ou plataforma) ou pela operação da Oneos. Status REPROVED.
pre_authorization.expired Pré-autorização expirada O prazo para o fornecedor solicitar acabou. Status REPROVED.

Antecipação

Tipo Quando
anticipation.created Antecipação criada O fornecedor antecipou uma nota diretamente, sem pré-autorização (origin: "DIRECT").
anticipation.requested Antecipação solicitada O fornecedor pediu a antecipação. Aguarda a aprovação da sua empresa (TO_APPROVE).
anticipation.approved Antecipação aprovada pela construtora A sua empresa aprovou, ou o prazo de aprovação passou com aprovação automática. Vai para análise.
anticipation.analysis_approved Análise aprovada (liberada para pagamento) A análise da Oneos aprovou. Liberada para pagamento ao fornecedor (TO_PAY).
anticipation.reproved Antecipação reprovada Reprovada pela sua empresa, pela operação ou pela análise da Oneos, ou porque o prazo de aprovação expirou. stage e reason dizem onde e por quê.
anticipation.reopened Antecipação reaberta para análise Uma operação reprovada na análise da Oneos foi reaberta e voltou para análise (IN_ANALYSIS). Chega depois de um anticipation.reproved da mesma operação.
anticipation.paid Pagamento ao fornecedor realizado A Oneos pagou o fornecedor (TO_BILL).
anticipation.payout_returned Pagamento ao fornecedor devolvido O banco devolveu o pagamento ao fornecedor depois do anticipation.paid. A operação volta a aguardar pagamento (TO_PAY).
anticipation.billed Boleto emitido O boleto para a sua empresa foi emitido (TO_RECEIVE). Traz bill: linha digitável, código de barras, vencimento e a URL do PDF.
anticipation.concluded Antecipação concluída O boleto foi pago e a operação terminou (CONCLUDED).

Prorrogação

Tipo Quando
anticipation.extension_created Prorrogação de boleto solicitada Foi pedida a prorrogação do boleto. Traz extension.
anticipation.extension_concluded Prorrogação paga (boleto trocado) A prorrogação foi paga e o boleto foi trocado. Traz extension e, para a construtora, bill com o boleto vigente.
anticipation.extension_canceled Prorrogação cancelada A prorrogação foi cancelada. Traz extension.

Nota fiscal

Tipo Quando
invoice.received Nota fiscal recebida Uma nota fiscal emitida contra a sua empresa chegou à Oneos pelo sincronismo com a SEFAZ.

Ordem de pagamento

Tipo Quando
payment_order.created Ordem de pagamento criada Uma ordem de pagamento (cashback/investback) foi gerada no fechamento mensal e está disponível para solicitação (AVAILABLE).
payment_order.under_review Ordem de pagamento em análise Uma ordem de pagamento (cashback/investback) foi solicitada e está em análise.
payment_order.scheduled Ordem de pagamento programada A ordem de pagamento foi aprovada e programada.
payment_order.paid Ordem de pagamento paga A ordem de pagamento foi paga.
payment_order.canceled Ordem de pagamento cancelada A ordem de pagamento foi cancelada.
payment_order.reproved Ordem de pagamento reprovada A ordem de pagamento foi reprovada.

Teste

TipoQuando
webhook.testEvento de teste Você clicou em Enviar evento de teste na plataforma. Chega mesmo sem estar entre os eventos escolhidos.

Formato do data por família

Pré-autorização, antecipação e prorrogação

Campos descritos em Receber eventos. Nas prorrogações, vem também o objeto extension.

Boleto

Em anticipation.billed e anticipation.extension_concluded, o endpoint da construtora (quem paga) recebe também o objeto bill com o boleto vigente. O fornecedor recebe o mesmo evento sem ele.

anticipation.billed · data.bill 
{
  "typeableLine": "00190000090114971860168524522114675860000102656",
  "barcode": "00196758600001026560000001149718606852452211",
  "dueDate": "2026-11-05",
  "ourNumber": "000123",
  "amount": 1026.56,
  "fileUrl": "https://app.oneos.com.br/api/integration/v1/anticipations/48211/bill-file"
}

O PDF não viaja no evento: baixe em bill.fileUrl com a mesma chave de API (escopo preauth:read). ourNumber, barcode e amount podem vir null.

Nota fiscal

invoice.received · data 
{
  "accessKey": "35260911222333000181550010000482111000482110",
  "number": "48211",
  "series": "1",
  "issuer": {
    "taxId": "11222333000181",
    "name": "Fornecedor Exemplo ME"
  },
  "amount": 18400,
  "issuedAt": "2026-09-14T15:32:00.000Z"
}

number, series, issuer.*, amount e issuedAt podem vir null.

Ordem de pagamento

payment_order.* · data 
{
  "paymentOrderId": 912,
  "status": "SCHEDULED",
  "rewardType": "CASHBACK",
  "amount": 1250.4,
  "referenceMonth": "2026-08",
  "requestedPayoutDate": "2026-09-20"
}

status: AVAILABLE, UNDER_REVIEW, SCHEDULED, PAID ou CANCELED. rewardType: CASHBACK ou INVESTBACK. requestedPayoutDate pode ser null.

Teste

webhook.test · data 
{
  "message": "Evento de teste enviado pela ONE — sua configuração de webhook está funcionando.",
  "company": {
    "cnpj": "44555666000199",
    "name": "Construtora Exemplo LTDA"
  }
}
Esc