1. Objetivo

Se você utiliza um CRM que não está entre os já integrados à plataforma LigueLead ou prefere realizar a integração de forma personalizada, é possível usar a integração via Webhook.

Essa integração permite conectar o seu CRM à LigueLead de forma simples, recebendo automaticamente os dados de leads sempre que ocorrer um novo evento.

2. Regras Gerais

Para garantir o funcionamento correto da integração, siga as orientações abaixo:

• Formato dos dados: todos os dados (payloads) devem ser enviados em JSON.
• Tipo de requisição: utilize sempre o método HTTP POST para enviar eventos.
• Campos obrigatórios: se algum campo obrigatório estiver ausente, a requisição será rejeitada automaticamente.
• Identificação do evento: inclua o campo event para indicar o tipo de evento enviado. Os valores válidos estão descritos nas seções seguintes.

3. Eventos Disponíveis

3.1 Criar Lead (create_lead)

Cria automaticamente um lead na plataforma LigueLead a partir do seu sistema.

Campos obrigatórios (JSON – lead):

• name – Nome do lead
• phone – Número de telefone
• ddd – DDD do telefone
• email – E-mail do lead
• event – create_lead

Exemplo de Payload:

3.2 Iniciar Flow (start_flow)

Inicia um fluxo automatizado para um lead.

Campos obrigatórios (JSON – lead):

• name
• phone
• ddd
• email
• event – start_flow

Exemplo de Payload:

3.3 Remover do Flow (exit_flow)

Remove um lead de um fluxo automatizado.

Campos obrigatórios (JSON – lead):

• name
• phone
• ddd
• email
• event – exit_flow

Exemplo de Payload:

3.4 Compra Aprovada (purchase_approved)

Registra uma compra aprovada vinculada a um produto.

Objetos no JSON:

• buyer (comprador)
• product (produto)

Campos obrigatórios buyer:

• name
• phone
• ddd
• ddi
• email

Campos obrigatórios product:

• payment_method
• external_product_id
• value
• payment_parcels
• event – purchase_approved

Exemplo de Payload:

3.5 Compra Cancelada (purchase_canceled)

Registra uma compra cancelada vinculada a um produto.

Objetos e campos – mesmos do evento purchase_approved, alterando apenas:

• event – purchase_canceled

Exemplo de Payload:

3.6 Carrinho Abandonado (abandoned_cart)

Notifica que um comprador abandonou o carrinho sem finalizar a compra.

Objetos no JSON:

• buyer (nome, telefone, DDD, DDI, email)
• product (external_product_id, event = abandoned_cart)

Exemplo de Payload:

3.7 Compra Atrasada (delayed_purchase)

Registra uma compra aprovada após atraso no pagamento.

Objetos e campos – mesmos de purchase_approved, alterando:

• event – delayed_purchase

Exemplo de Payload:

3.8 Compra Completa (complete_purchase)

Registra uma compra concluída (ex.: boleto pago após atraso).

Objetos e campos – mesmos de purchase_approved, alterando:

• event – complete_purchase

Exemplo de Payload:

3.9 Aguardando Pagamento (waiting_payment)

Indica que a compra foi iniciada, mas o pagamento ainda está pendente.

Objetos e campos – mesmos de purchase_approved, alterando:

• event – waiting_payment

Exemplo de Payload:

3.10 Compra Reembolsada (refunded_purchase)

Informa que uma compra foi reembolsada ao cliente.

Objetos e campos – mesmos de purchase_approved, alterando:

• event – refunded_purchase

Exemplo de Payload:

3.11 Chargeback (chargeback)

Registra que uma compra sofreu contestação junto à operadora e foi estornada.

Objetos e campos – mesmos de purchase_approved, alterando:

• event – chargeback

Exemplo de Payload:

3.12 Compra Expirada (expired_purchase)

Notifica que o prazo para pagamento expirou e o pedido não foi concluído.

Objetos e campos – mesmos de purchase_approved, alterando:

• event – expired_purchase

Exemplo de Payload:

3.13 Solicitação de Reembolso (refund_request)

Notifica que o cliente solicitou o reembolso de uma compra.

Objetos e campos – mesmos de purchase_approved, alterando:

• event – refund_request

Exemplo de Payload: