É possível integrar a HeroSpark com ferramentas externas para automação de mensagens, como a Voxuy utilizando qualquer gatilho do Piloto Automático.
Para isso, siga os passos abaixo.
Passo 1 - Copiar Webhook e API na Voxuy
Acesse o submenu “Configurações” e clique em “Integrações”. Clique em “API Voxuy”, copie e guarde os códigos da “URL para Webhook” e “Token API” para utilizar nos próximos passos.
Passo 2 - Adicionar produto na Voxuy
Ainda no submenu “Configurações” e clique em “Produtos”. Adicione o produto que será integrado com a HeroSpark e informe o “nome do produto” e em “Automação”, selecione a opção “Voxuy - API” e clique em “Salvar”.
Passo 3 - Adicionar plano ao produto na Voxuy
Ainda no menu “Produtos”, clique em “Adicionar plano” e informe o nome do plano que será vinculado ao produto. Após a criação do plano, clique nos “3 pontos” em frente ao nome do plano, copie e guarde o código do plano para utilizar nos próximos passos.
Passo 4 - Personalizar os eventos na Voxuy
Acesse o submenu “Automações” e clique em “API”. Selecione o “Produto” e clique no sinal de + para criar os eventos personalizados da HeroSpark, é possível utilizar qualquer evento do “Piloto Automático”, nesse exemplo, estamos usando “Cartão de crédito recusado” e “Pix criado”.
Clique no nome do evento personalizado criado, copie e guarde o “ID de cada evento” para utilizar nos próximos passos.
Passo 5 - Variáveis Metadata na Voxuy
A Voxuy possui uma lista padrão de variáveis que podem ser utilizadas para personalização das mensagens e para utilizar as variáveis personalizadas da HeroSpark, é necessário adicionar a opção “metadata”. A lista das variáveis personalizadas da HeroSpark são:
- Nome do produto: {Meta:nomeproduto}
- URL do pix: {Meta:urlpix}
- Código do pix: {Meta:codigopix}
- Data de expiração do pix: {Meta:dataexpiracaopix}
- URL do boleto: {Meta:urlboleto}
- Código do boleto: {Meta:codigoboleto}
- Data de vencimento do boleto: {Meta:datavencimentoboleto}
- Motivo recusa do cartão de crédito: {Meta:motivorecusacartao}
- Data da próxima fatura recorrência: {Meta:dataproximafaturarecorrencia}
- Data de encerramento da recorrência: {Meta:dataencerramentorecorrencia}
- Data de término do ciclo atual de assinatura: {Meta:dataterminocicloassinatura}
Passo 6 - Configurar sua automação no Piloto Automático da HeroSpark
Acesse o Piloto Automático na HeroSpark e crie a automação com o modelo desejado, escolhendo a opção “Webhook”. Neste exemplo, foi utilizado o "Pix Criado", mas qualquer uma pode ser utilizada preenchendo os campos da seguinte forma:
Filtro de Disparo
Obrigatório filtrar o produto desejado, apenas um produto por automação.
URL
Cole exatamente o código da URL do Webhook copiado no “Passo 1”.
Método
Não faça nenhuma alteração, mantendo o valor padrão “(POST)”.
Em Headers
Crie uma entrada com os valores:
Chave: Content-Type
Valor: application/json
Body
Copie e cole exatamente o código a seguir:
{"id": "{{ payment_id }}", "date": "{{ payment_date }}", "planId": "Digitar aqui o código do plano", "status": 99, "apiToken": "Digitar aqui o Token API", "metadata": { "urlpix": "{{ pix_qr_code_url }}", "codigopix": "{{ pix_code }}", "urlboleto": "{{ bank_slip_file_url }}", "nomeproduto": "{{ product_name }}", "codigoboleto": "{{ bank_slip_barcode }}", "dataexpiracaopix": "{{ pix_expiration_at }}", "motivorecusacartao": "{{ credit_card_refused_message }}", "datavencimentoboleto": "{{ boleto_expiration_at }}", "dataterminocicloassinatura": "{{ subscription_available_until }}", "dataencerramentorecorrencia": "{{ subscription_expiration_at }}", "dataproximafaturarecorrencia": "{{ subscription_next_invoice_at }}" }, "clientName": "{{ buyer_name }}","clientEmail": "{{ buyer_email }}", "customEvent": "Digitar aqui o ID do evento personalizado", "paymentType": 99, "clientDocument": "{{ buyer_document_id }}", "clientPhoneNumber": "+55{{ buyer_phone }}"}
Substitua os valores dos seguintes campos mantendo entre aspas duplas " ":
- apiToken: Digite o token API copiado no Passo 1
- planid: Digite o código do plano copiado no Passo 3
- customEvent: Digite o ID do evento personalizado copiado no Passo 4
Atenção! Lembre de ativar a sua automação.
Passo 7 - Testando sua integração
Para testar a integração é necessário efetuar uma ação para disparo do gatilho da automação na HeroSpark, no exemplo criado para “Pix Criado”, uma compra por “Pix” deve ser finalizada no checkout da HeroSpark.
Problemas?
Caso você tenha problemas, entre em contato diretamente com o suporte da Voxuy.