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	data_vencimento url_boleto linha_digitavel_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	cartao_pago		Transação no cartão de crédito aprovada
Pix Gerado	pix_gerado	url_pix vencimento_pix	Um código PIX foi gerado
Pix Pago	pix_pago		Pagamento via PIX foi efetuado
Pedido Cancelado	pedido_cancelado		Um pedido foi cancelado
Assinatura Criada	assinatura_criada		Nova assinatura criada
Assinatura Aguardando Pagamento	assinatura_aguardando_pagamento	url_pix vencimento_pix url_boleto vencimento_boleto	Assinatura está aguardando o pagamento
Assinatura Paga	assinatura_paga		Assinatura paga
Assinatura Vencida	assinatura_vencida		Assinatura vencida

---

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.

• email: E-mail do lead.

• event_id: Identificador do evento.

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

Campos Adicionais

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

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

• linha_digitavel_boleto: Número do boleto (quando event_id for boleto_gerado).

• vencimento_boleto: Data de vencimento do boleto (quando event_id for boleto_gerado).

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

• vencimento_pix: Data de vencimento do 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:

{
    "tipo_evento": "pix_gerado",
    "forma_pagamento": "pix",
    "url_checkout": "https://checkout.minhaloja.com.br/payment/asdfqwe12312dq12e",
    "dados_pagamento": {
        "url_pix": "https://pay.minhaloja.com.br/payment/asdfqwe12312dq12e",
        "vencimento_pix": "2024-07-01 12:10:53",
        "qrcode": "00020101021226770014BR.GOV.BCB.PIX2555api.itau/pix/qr/v2/084e5804-11da-4495-adec-ca66f0cff3585204000053039865802BR5906APPMAX6009SAO PAULO62070503***63047F7B"
    },
    "dados_cliente":{
        "nome":"Teste Teste",
        "telefone":"61974022942",
        "email":"[e-mail]"
    },
    "dados_produto":{
        "id": "OZYUHYYWG4645OFD",
        "nome": "Meu produto",
        "valor_unitario": 0,
        "quantidade": 0,
        "valor_total": 97.00,
        "url_checkout":"https://pay.minhaloja.com.br/asdfqwe12312dq12e"
    }
}

Para o evento cartao_pago:

{
    "tipo_evento": "cartao_pago",
    "forma_pagamento": "cartao",
    "url_checkout": "https://checkout.minhaloja.com.br/payment/asdfqwe12312dq12e",
    "dados_pagamento": {
        "bandeira": "VISA",
        "data_pagamento": "2024-07-01 12:10:53"
    },
    "dados_cliente":{
        "nome":"Teste Teste",
        "telefone":"61974022942",
        "email":"[e-mail]"
    },
    "dados_produto":{
        "id": "OZYUHYYWG4645OFD",
        "nome": "Meu produto",
        "valor_unitario": 0,
        "quantidade": 0,
        "valor_total": 97.00,
        "url_checkout":"https://pay.minhaloja.com.br/asdfqwe12312dq12e"
    }
}

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.