> ## Knowledge Base Index > Fetch the complete knowledge base index at: https://help.onprofit.com.br/sitemap.xml > Use this file to discover available pages before exploring further. > Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash). # 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. ${youtube}[Como Integrar com Webhook na OnProfit?](BbtJu-kVk7M) ### 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. || Importante: após criar a integração, é necessário no produto dentro da aba "webhook em "Editar" produto. ### 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](https://help.onprofit.com.br/pt/article/quais-sao-os-status-de-vendas-pra-webhook-1su3xwh/?bust=1735258503002). 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](mailto:comercial@onprofit.com.br).