Como integrar com Webhooks?

Como integrar com Webhooks?

A integração de webhooks é essencial para automatizar a comunicação entre a OnProfit e outras plataformas. Com essa funcionalidade, é possível enviar informações em tempo real sempre que determinados eventos ocorrerem. A seguir, você encontrará um guia detalhado para configurar um webhook.

Como integrar um Webhook à OnProfit?

1. Acesse a OnProfit: faça login na sua conta OnProfit e navegue até integrações de Webhooks: No menu lateral, clique em Integrações > Webhooks > Integrar > Adicionar integração.
2. Preencha os campos solicitados: A OnProfit solicitará as seguintes informações.
3. Nome do Webhook: Defina um nome descritivo para identificar facilmente a integração.
4. URL da API: Insira a URL da API do sistema que você deseja integrar. Essa URL será o destino das informações enviadas.
5. Quando Disparar: Determine o evento que acionará o webhook, como: Criação de um pedido, atualização de status, cancelamento de uma assinatura, conclusão de um pagamento e etc.

Teste o Webhook:

Após preencher os campos verifique se a URL da API está configurada corretamente e se a comunicação é bem-sucedida. Clique em Atualizar para salvar.

Exemplo de Payloads para Integração com Webhooks:

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. Abaixo, explicaremos os principais campos de um payload de exemplo, como o apresentado aqui:

Estrutura do Payload (Webhook V1):

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").

"order_reason": Motivo da compra não ter sido aprovada.

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, como:

"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, como:

"orderbump_id": Identificação da oferta adicional.

"orderbump_name": Nome da oferta adicional.

"orderbump_price": Preço da oferta adicional.

Estrutura do Payload (Webhook V2):

Informações do Pedido

• object: Tipo do objeto enviado (order).
• id: Identificação única do pedido.
• item_type: Tipo do item vendido (ex.: product).
• user_id: ID do usuário (produtor) na OnProfit.
• customer_id: ID do cliente comprador.
• product_id: ID do produto vendido.
• delivery: Tipo ou código de entrega.
• offer_id: ID da oferta associada ao pedido.
• offer_name: Nome da oferta.
• offer_price: Valor da oferta (em centavos).
• price: Valor total do pedido (em centavos).
• currency: Moeda da transação (ex.: BRL).
• payment_type: Tipo de pagamento (ex.: cc, pix, billet).
• purchase_date: Data e hora da compra.
• confirmation_purchase_date: Data e hora da confirmação do pagamento.
• status: Status atual do pedido (ex.: PAID).
• smartpayment: Indica uso de smart payment (0 = não, 1 = sim).

Informações do Cliente

Objeto customer:

• name: Nome do comprador.
• lastname: Sobrenome do comprador.
• document: Documento do cliente (CPF/CNPJ).
• email: E-mail do cliente.
• phone: Telefone com formatação.
• cell: Telefone no padrão internacional.

Endereço do Cliente

Objeto customer_address:

• street: Rua.
• number: Número.
• complement: Complemento.
• city: Cidade.
• state: Estado.
• zip_code: CEP.
• neighborhood: Bairro.
• country: País.

Informações do Produto

Objeto product:

• id: ID do produto.
• name: Nome do produto.
• hash: Identificador único do produto.

Informações de Assinatura (quando aplicável)

• subscription: Dados da assinatura, quando o pedido for recorrente.

(Campo pode retornar null para compras avulsas.)

Quando Disparar o Webhook?

Você pode configurar a OnProfit para disparar o webhook em eventos específicos, como:

• Criação de Pedido: Quando um novo pedido é criado.
• Alteração de Status: Quando o status do pedido é atualizado (ex.: "approved", "cancelled").
• Pagamento Confirmado: Quando um pagamento é aprovado.

Exemplo de Uso: ao receber o payload, você pode usar os dados para:

• Atualizar automaticamente os sistemas de ERP com novos pedidos.
• Enviar confirmações de compra para o cliente via e-mail ou SMS.
• Criar fluxos automatizados para entrega de cursos ou produtos.

Payloads Variáveis:

Alguns campos no payload podem variar dependendo da situação específica de cada pedido. Para mas informações sobre Status de vendas clique aqui. Abaixo estão os principais campos variáveis e os possíveis valores:

• Variáveis de order_payment_type: Este campo indica o tipo de pagamento utilizado no pedido. Os valores possíveis são:

• credit_card: Pagamento realizado com cartão de crédito.
• pix: Pagamento realizado via PIX.
• billet: Pagamento realizado com boleto bancário.
• Cc_Pix: Combinação de pagamento via cartão de crédito e PIX.
• Cc_Billet: Combinação de pagamento via cartão de crédito e boleto bancário.
• Cc_Cc: Pagamento realizado com múltiplos cartões de crédito.

Variáveis de order_status (Webhook V1): Este campo indica o status atual do pedido. Os valores possíveis são:

• started: Pedido iniciado, mas ainda não concluído.
• approved: Pedido aprovado com sucesso.
• refunded: Pedido reembolsado.
• cancelled: Pedido cancelado.
• refused: Pedido recusado (ex.: problemas no pagamento).
• chargeback: Pedido sofreu chargeback.

Variáveis de order_status (Webhook V2):

• STARTED:

Pedido iniciado, mas o pagamento ainda não foi concluído.

• WAITING:

Pedido criado e aguardando a conclusão do pagamento pelo comprador (ex.: PIX gerado aguardando pagamento, boleto em aberto).

• PAID:

Pagamento confirmado com sucesso.

• AUTHORIZED:

Pagamento autorizado pelo meio de pagamento (ex.: cartão autorizado), aguardando confirmação ou captura final.

• MANUALLY_AUTHORIZED:

Pagamento autorizado manualmente por alguma ação administrativa ou ajuste interno.

• IN_ANALYSIS:

Pagamento em análise antifraude ou em validação pelo gateway.

• CANCELLED:

Pedido cancelado antes da conclusão do pagamento.

• REFUNDED:

Pedido que teve o pagamento confirmado anteriormente e foi posteriormente reembolsado.

• CHARGEBACK:

Pedido que sofreu chargeback após contestação do comprador junto ao banco ou operadora.

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.

Atualizado em: 29/01/2026