Como integrar com SMSFunnel?

Um passo a passo detalhado sobre como integrar sua plataforma com a SMSFunnel de forma simples e prática.

Integração SMSFunnel

A integração entre SMSFunnel e sua plata ocorre via webhooks, permitindo a comunicação em tempo real entre os sistemas.

Sumário

1. Eventos Suportados

2. Estrutura do Payload

3. Exemplo de Requisição

4. Testando Integrações

5. Quero integrar minha plataforma

---

Eventos Suportados

Os seguintes eventos são capturados pela integração. O campo event_id deve ser enviado no payload para determinar o evento correspondente:

Evento	event_id	Campos Adicionais Necessários	Descrição
Abandono de Checkout	abandono_checkout	link_checkout	Lead abandonou o checkout
Boleto Gerado	boleto_gerado	link_boleto	Um boleto foi gerado
Boleto Pago	boleto_pago		Um boleto foi pago
Boleto Vencido	boleto_vencido		Um boleto venceu
Cartão de Crédito Pago	cc_pago		Transação no cartão de crédito aprovada
Cartão de Crédito Negado	cc_negado		Transação no cartão foi negada
Pedido Cancelado	pedido_cancelado		Um pedido foi cancelado
Pix Gerado	pix_gerado	codigo_pix, url_pix	Um código PIX foi gerado
Pix Pago	pix_pago		Pagamento via PIX foi efetuado
Novo Cadastro	cadastro_cliente		Cleinte cadastrado na plataforma

---

Estrutura do Payload

Todos os eventos seguem o mesmo formato básico, com campos adicionais dependendo do event_id.

Campos Obrigatórios

• phone: Número de telefone do lead.

• name: Nome do lead.

• event_id: Identificador do evento.

• value: Valor associado ao evento (obrigatório para eventos financeiros como pagamento ou cancelamento).

Campos Adicionais

• link_checkout: URL do checkout (quando event_id for abandono_checkout).

• link_boleto: URL do boleto (quando event_id for boleto_gerado).

• codigo_pix: Código para pagamento PIX (quando event_id for pix_gerado).

• url_pix: URL para pagamento PIX (quando event_id for pix_gerado).

---

Exemplo de Requisição

Segue um exemplo para o evento pix_gerado:

{
  "phone": "99999999999",
  "name": "João Silva",
  "email": "[e-mail]",
  "event_id": "pix_gerado",
  "codigo_pix": "1234567890",
  "url_pix": "https://pagamento.pix.url",
  "value": "200.50"
}

Para o evento cc_pago:

{
  "phone": "99999999999",
  "name": "João Silva",
  "email": "[e-mail]",
  "event_id": "cc_pago",
  "value": "450.75"
}

Recomenda-se o uso da ferramenta Webhook.site para validar payloads antes de enviar ao endpoint.

---

Testando a integração

Uma vez que você tenha desenvolvido a integração, será hora de testá-la. Para isso, certifique-se de que você já tem:

• Uma conta com crédito no SMSFunnel. (Se não tiver, realize o cadastro em cadastro.smsfunnel.com.br)
• Acesso a uma conta com perfil de cliente em sua plataforma, que lhe permita configurar o webhook e validá-lo.

Com todos os requisitos em mãos, acesso o SMSFunnel e realize ESSE PROCESSO (Clique no link).

---

Quero integrar minha plataforma

Ficamos muito felizes em saber que você deseja integrar sua plataforma com o SMSFunnel. Essa é uma excelente decisão, pois seus clientes terão uma maior taxa de conversão como resultado.

O tempo médio para disponibilização de uma nova integração em produção é de 30 dias. Por favor, preencha ESTE FORMULÁRIO (clique no link) para que possamos iniciar o processo de integração.

Nossa equipe técnica entrará em contato com você em até 16 horas úteis após o preenchimento deste formulário.