# Como integrar com SMSFunnel?

## 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<br>

***

### 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:

<table data-header-hidden><thead><tr><th></th><th width="187"></th><th></th><th></th></tr></thead><tbody><tr><td><strong>Evento</strong></td><td><strong><code>event_id</code></strong></td><td><strong>Campos Adicionais Necessários</strong></td><td><strong>Descrição</strong></td></tr><tr><td>Abandono de Checkout</td><td><code>abandono_checkout</code></td><td><code>link_checkout</code></td><td>Lead abandonou o checkout</td></tr><tr><td>Boleto Gerado</td><td><code>boleto_gerado</code></td><td><code>data_vencimento url_boleto linha_digitavel_boleto</code></td><td>Um boleto foi gerado</td></tr><tr><td>Boleto Pago</td><td><code>boleto_pago</code></td><td></td><td>Um boleto foi pago</td></tr><tr><td>Boleto Vencido</td><td><code>boleto_vencido</code></td><td></td><td>Um boleto venceu</td></tr><tr><td>Cartão de Crédito Pago</td><td><code>cartao_pago</code></td><td></td><td>Transação no cartão de crédito aprovada</td></tr><tr><td>Pix Gerado</td><td><code>pix_gerado</code></td><td><code>url_pix vencimento_pix</code></td><td>Um código PIX foi gerado</td></tr><tr><td>Pix Pago</td><td><code>pix_pago</code></td><td></td><td>Pagamento via PIX foi efetuado</td></tr><tr><td>Pedido Cancelado</td><td><code>pedido_cancelado</code></td><td></td><td>Um pedido foi cancelado</td></tr><tr><td>Assinatura Criada</td><td><code>assinatura_criada</code></td><td></td><td>Nova assinatura criada</td></tr><tr><td>Assinatura Aguardando Pagamento</td><td><code>assinatura_aguardando_pagamento</code></td><td><code>url_pix vencimento_pix url_boleto vencimento_boleto</code></td><td>Assinatura está aguardando o pagamento</td></tr><tr><td>Assinatura Paga</td><td><code>assinatura_paga</code></td><td></td><td>Assinatura paga</td></tr><tr><td>Assinatura Vencida</td><td><code>assinatura_vencida</code></td><td></td><td>Assinatura vencida</td></tr></tbody></table>

***

### 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`:

```json
{
    "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":"teste@gmail.com"
    },
    "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`:

```json
{
    "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":"teste@gmail.com"
    },
    "dados_produto":{
        "id": "OZYUHYYWG4645OFD",
        "nome": "Meu produto",
        "valor_unitario": 0,
        "quantidade": 0,
        "valor_total": 97.00,
        "url_checkout":"https://pay.minhaloja.com.br/asdfqwe12312dq12e"
    }
}
```

\ <mark style="color:red;">**Recomenda-se o uso da ferramenta**</mark> [**Webhook.site**](http://webhook.site) <mark style="color:red;">**para validar payloads antes de enviar ao endpoint.**</mark>

***

### 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](https://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)](https://scribehow.com/shared/Como_cadastrar_integracao_no_SMSFunnel__5At8-ITRTXeSv0hmhrya9A).<br>

***

### 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) ](https://forms.clickup.com/9013484465/f/8ckxpxh-873/O1YSJS8BZRWD7ZK7H2)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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.smsfunnel.com.br/como-integrar-com-smsfunnel.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.