> For the complete documentation index, see [llms.txt](https://docs.smsfunnel.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.smsfunnel.com.br/integracoes.md).

# Integrações

{% hint style="info" %}
**Atenção:** O primeiro passo é você possuir uma conta validada na nossa plataforma. Entre em [`https://smsfunnel.com.br`](https://smsfunnel.com.br) e inicie o seu cadastro, caso ainda não tenha.
{% endhint %}

#### Sobre o webhook

O webhook é um termo comum do mercado de requisição para um servidor web através do verbo HTTP POST.

#### Dados enviados

Por meio dos webhooks, ficou convencionado no mercado o envio das seguintes informações:

```json
{
    "tipo_evento": "pix_pago",
    "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"
    }
}
```

### Como funciona a organização dos dados

A plataforma SMS Funnel possui o conceito de listas, onde cada evento da plataforma irá gerar uma lista. 

À partir do recebimento do postback pelo link de integração, o sistema utilizará o evento e a forma de pagamento para direcionar o lead para sua respectiva lista.

O sistema irá controlá em qual parte do funil o seu cliente está, sendo que a cada evento ele irá mudar de lista.

***Exemplo:*** O cliente entra como um **carrinho abandonado**. Após um certo período, se ele clicar em finalizar pagamento e gerar um PIX, automaticamente ele irá sair da lista de carrinho abandonado e será movimentado para a lista de **PIX Gerado**.  

### Tipos de Evento

```php
pix_gerado
pix_pago
pix_expirado
cartao_pago
boleto_gerado
boleto_pago
boleto_expirado
carrinho_abandonado
pedido_cancelado
assinatura_criada
assinatura_aguardando_pagamento
assinatura_paga
assinatura_vencida
```

### Formas de Pagamento

```
pix
boleto
cartao
```

### Dados Pagamento - PIX

```
"url_pix": "https://pay.minhaloja.com.br/payment/asdfqwe12312dq12e",
"vencimento_pix": "2024-07-01 12:10:53",
"qrcode": "0
```

### Dados Pagamento - Boleto

```
"url_boleto": "https://pay.minhaloja.com.br/payment/asdfqwe12312dq12e",
"vencimento_boleto": "2024-07-01 12:10:53",
"linha_digitavel_boleto": "00190000090281239800215312977174811080000234627"
```

### Sobre a automação

À partir das listas criadas, você deverá entrar no menu **Automações** para configuar as automações baseada na fase em que seu cliente se encontra, podendo configurar mensagens específicas para cada lista. 

Nossa equipe comercial vai lhe ajudar montar suas mensagens, sendo que você tem à disposição na ferramenta a possibilidade de personalizar mensagens com os dados do seu cliente, tornando elas mais pessoais.

O controle e movimentação dos leads fará, por exemplo, que um cliente que tinha abandonado o carrinho receba uma mensagem de recuperação e quando ele realizar o pagamento, que a(s) próxima(s) mensagens sejam de confirmação do pagamento por exemplo e com isso evite dele continuar recebendo mensagens de recuperação.

###