Payloads para integração com webhooks na OnProfit
Na OnProfit, o payload é o conjunto de informações que descrevem cada transação. Ele é essencial para integrações, automações e análises detalhadas das suas vendas.
Quando você configura um webhook, a OnProfit envia dados estruturados em formato JSON para a URL configurada. Esses dados, chamados de payloads, contêm informações detalhadas sobre o evento disparado, como pedidos, usuários e cursos.
Estrutura do Payload
O payload enviado pela OnProfit contém informações organizadas em diferentes níveis. A seguir, destacamos os principais campos:
Informações do pedido
"object": Tipo do objeto enviado, neste caso,"order"(pedido).
"order_id": Identificação única do pedido.
"order_delivery": Método ou código de entrega.
"order_off": Código da oferta associada ao pedido.
"order_off_name": Nome da oferta.
"order_off_price": Preço da oferta.
"order_price": Valor total do pedido.
"order_installments": Quantidade de parcelas.
"order_installment": Valor de cada parcela.
"order_currency": Moeda usada no pedido (ex.: BRL).
"order_payment_type": Tipo de pagamento (ex.:"credit_card").
"order_status": Status do pedido (ex.:"approved").
Dados do usuário
"user_name": Nome do comprador.
"user_lastname": Sobrenome do comprador.
"user_document": Documento de identificação (ex.: CPF).
"user_email": E-mail do comprador.
"user_cell": Número de celular com formatação.
"user_cell_no_formatted": Número de celular sem formatação.
Informações da assinatura
"subscription_id": Identificação única da assinatura, caso aplicável.
Dados de entrega
"order_address": Detalhes do endereço de entrega
"street": Nome da rua.
"number": Número do endereço.
"city": Cidade.
"state": Estado.
"zip_code": CEP.
Informações do curso
"course_id": Identificação do curso associado ao pedido.
"course_name": Nome do curso.
Dados de ofertas complementares (Orderbump)
"order_orderbump": Indica se há uma oferta adicional.
"orderbump": Detalhes das ofertas adicionais:
"orderbump_id": Identificação da oferta adicional.
"orderbump_name": Nome da oferta adicional.
"orderbump_price": Preço da oferta adicional.
Campos variáveis no Payload
Alguns campos no payload podem variar dependendo da situação específica de cada pedido. Abaixo estão os principais:
order_payment_type – Tipo de pagamento
Este campo indica como o pagamento foi feito:
credit_card: Cartão de crédito
pix: PIX
billet: Boleto bancário
Cc_Pix: Cartão de crédito + PIX
Cc_Billet: Cartão de crédito + Boleto
Cc_Cc: Múltiplos cartões de crédito
order_status – Status do pedido
Este campo mostra o andamento do pedido:
started: Pedido iniciado ( Aguardando pagamento)
approved: Pagamento aprovado
refunded: Pedido reembolsado
cancelled: Pedido cancelado
refused: Pagamento recusado
chargeback: Disputa com a operadora (chargeback)
cart_abandon: Carrinho abandonado
Precisa de Ajuda?
Se você tiver dúvidas ou precisar de suporte adicional, entre em contato com o nosso suporte pelo e-mail: comercial@onprofit.com.br.
Actualizado em: 01/07/2025
Obrigado!