Como integrar com a HeroSpark?
"Esta integração está em modo Alpha." No "Modo alpha", nosso sistema está aprendendo sobre os tipos de notificações enviadas. Mas, pode ficar tranquilo! A plataforma é super inteligente e não irá enviar notificações repetidas, ok?
Como configurar a integração?
Dentro do Notificações Inteligentes
Para criar a integração, acesse a sua conta do Notificações Inteligentes e clique em Lojas:
Na página, clique em Criar loja:
Em seguida, na opção Descrição, é possível dar um apelido para a integração criada:
Na Plataforma, selecione a opção com o nome da integração, na categoria Checkout, como demonstrado na imagem abaixo:
Dentro da HeroSpark
Entre em sua conta da HeroSpark e, no menu localizado a esquerda de sua tela, clique em Piloto Automático:
Agora, clique em Modelos de automação:[](https://app.herospark.com/automations/#)
Em seguida, selecione um modelo de automação de sua escolha, ele deve estar listado entre os modelos de automação suportados pelo Notificações Inteligentes:
Cartão de crédito recusado;
Assinatura cancelada pelo cliente;
Assinatura cancelada pelo produtor;
Pagamento confirmado;
Boleto gerado;
Pix criado.
Após a seleção do modelo de automação você deverá seguir alguns passos:
Será necessário que você selecione a opção Gerar um Webhook e depois clicar na confirmação, para que seu modelo nos envie webhooks:
Na opção Filtro de disparo, secione a opção de sua escolha:
Na opção Edição de webhook, no campo URL digite a URL da integração da HeroSpark que foi criada no Notificações Inteligentes e, no campo Método, selecione a opção POST:
Caso não saiba onde pegar a URL no Notificações Inteligentes, acesse
este artigo e siga o passo a passo.
O próximo passo deve ser configurado com muita atenção, por isso, siga as nossas recomendações.
No campo Headers será preciso realizar a seguinte alteração:
No campo Body será de extrema importância que você siga rigorosamente o exemplo da imagem abaixo:
{
"name": "{{buyer_name}}",
"email": "{{buyer_email}}",
"phone": "{{buyer_phone}}",
"document": "{{buyer_document_id}}",
"offer_kind": "{{offer_kind}}",
"payment_id": "{{payment_id}}",
"product_id": "{{product_id}}",
"offer_price": "{{offer_price}}",
"offer_title": "{{offer_title}}",
"payment_date": "{{payment_date}}",
"product_name": "{{product_name}}",
"document_type": "{{buyer_document_type}}",
"payment_method": "{{payment_method}}",
"payment_status": "{{payment_status}}"
}
Caso você tenha dificuldade em configurar o Body de seu modelo de automação, basta copiar o exemplo acima.
Para finalizar, clique em Salvar edição e depois marque como Ativada.
Pronto! Sua integração foi feita com sucesso! Agora, vamos começar a receber os eventos e, consequentemente, enviar as notificações.
Quero criar vários modelos de automação como faço?
Nesse caso, repita o procedimento para cada modelo de automação.
Como sei que deu certo?
Quer conferir se a integração do Notificações Inteligentes foi feita de maneira certa? Então, veja como você pode fazer a confirmação, seguindo estas etapas:
Verifique o checklist dentro da sua loja
Temos um checklist que te ajuda a entender se todas as configurações necessárias para o envio das notificações foram feitas.
Você consegue ter um exemplo do checklist logo abaixo:
Se todas as opções estiverem na cor verde, quer dizer que você fez todos os passos. Então, provavelmente, as notificações já devem estar sendo enviadas.
Acompanhe a tela de relatórios
Na tela de relatórios, seja da integração ou da instância, você consegue ter uma ideia geral das notificações que estão sendo enviadas.
Caso não saiba onde fica esta tela, acesse este artigo para saber como verificar os relatórios.
Verifiquei todos os passos acima e mesmo assim acredito que não esteja funcionando
Nesse caso, temos um checklist mais detalhado que você consegue ver ele aqui.
Quando as notificações serão disparadas?
Como essa é uma integração instantânea, assim que a plataforma nos enviar as informações, iremos processar e agendar a mensagem na fila de envios. Caso você não saiba o que é uma fila de envios, clique aqui.
Quais são as notificações disponíveis?
Todas as notificações listadas na tabela abaixo estão disponíveis e funcionando. Antes de você conhecê-las, entenda como cada uma delas funciona.
Veja, então, o que significa cada coluna das notificações disponíveis:
Prioridade no caminho feliz: se esta função estiver disponível, ela vai indicar a ordem de envio das mensagens seguindo a lógica do chamado “caminho feliz”. Você pode ler mais sobre ele aqui;
Nome da notificação: é o nome que damos para a notificação dentro do nosso painel;
Como reconhecemos o evento: em algumas integrações, deixamos documentada a maneira como elas são reconhecidas pelo nosso sistema. Isso acontece porque algumas delas podem ser personalizadas. Mas, se o reconhecimento não estiver disponível, pode ficar tranquilo pois isso não afeta qualquer usabilidade do sistema.
Como configurar a integração?
Dentro do Notificações Inteligentes
Para criar a integração, acesse a sua conta do Notificações Inteligentes e clique em Lojas:
Na página, clique em Criar loja:
Em seguida, na opção Descrição, é possível dar um apelido para a integração criada:
Na Plataforma, selecione a opção com o nome da integração, na categoria Checkout, como demonstrado na imagem abaixo:
Dentro da HeroSpark
Entre em sua conta da HeroSpark e, no menu localizado a esquerda de sua tela, clique em Piloto Automático:
Agora, clique em Modelos de automação:[](https://app.herospark.com/automations/#)
Em seguida, selecione um modelo de automação de sua escolha, ele deve estar listado entre os modelos de automação suportados pelo Notificações Inteligentes:
Cartão de crédito recusado;
Assinatura cancelada pelo cliente;
Assinatura cancelada pelo produtor;
Pagamento confirmado;
Boleto gerado;
Pix criado.
Após a seleção do modelo de automação você deverá seguir alguns passos:
Será necessário que você selecione a opção Gerar um Webhook e depois clicar na confirmação, para que seu modelo nos envie webhooks:
Na opção Filtro de disparo, secione a opção de sua escolha:
Na opção Edição de webhook, no campo URL digite a URL da integração da HeroSpark que foi criada no Notificações Inteligentes e, no campo Método, selecione a opção POST:
Caso não saiba onde pegar a URL no Notificações Inteligentes, acesse
este artigo e siga o passo a passo.
O próximo passo deve ser configurado com muita atenção, por isso, siga as nossas recomendações.
No campo Headers será preciso realizar a seguinte alteração:
No campo Body será de extrema importância que você siga rigorosamente o exemplo da imagem abaixo:
{
"name": "{{buyer_name}}",
"email": "{{buyer_email}}",
"phone": "{{buyer_phone}}",
"document": "{{buyer_document_id}}",
"offer_kind": "{{offer_kind}}",
"payment_id": "{{payment_id}}",
"product_id": "{{product_id}}",
"offer_price": "{{offer_price}}",
"offer_title": "{{offer_title}}",
"payment_date": "{{payment_date}}",
"product_name": "{{product_name}}",
"document_type": "{{buyer_document_type}}",
"payment_method": "{{payment_method}}",
"payment_status": "{{payment_status}}"
}
Caso você tenha dificuldade em configurar o Body de seu modelo de automação, basta copiar o exemplo acima.
Para finalizar, clique em Salvar edição e depois marque como Ativada.
Pronto! Sua integração foi feita com sucesso! Agora, vamos começar a receber os eventos e, consequentemente, enviar as notificações.
Quero criar vários modelos de automação como faço?
Nesse caso, repita o procedimento para cada modelo de automação.
Como sei que deu certo?
Quer conferir se a integração do Notificações Inteligentes foi feita de maneira certa? Então, veja como você pode fazer a confirmação, seguindo estas etapas:
Verifique o checklist dentro da sua loja
Temos um checklist que te ajuda a entender se todas as configurações necessárias para o envio das notificações foram feitas.
Você consegue ter um exemplo do checklist logo abaixo:
Se todas as opções estiverem na cor verde, quer dizer que você fez todos os passos. Então, provavelmente, as notificações já devem estar sendo enviadas.
Acompanhe a tela de relatórios
Na tela de relatórios, seja da integração ou da instância, você consegue ter uma ideia geral das notificações que estão sendo enviadas.
Caso não saiba onde fica esta tela, acesse este artigo para saber como verificar os relatórios.
Verifiquei todos os passos acima e mesmo assim acredito que não esteja funcionando
Nesse caso, temos um checklist mais detalhado que você consegue ver ele aqui.
Quando as notificações serão disparadas?
Como essa é uma integração instantânea, assim que a plataforma nos enviar as informações, iremos processar e agendar a mensagem na fila de envios. Caso você não saiba o que é uma fila de envios, clique aqui.
Quais são as notificações disponíveis?
Todas as notificações listadas na tabela abaixo estão disponíveis e funcionando. Antes de você conhecê-las, entenda como cada uma delas funciona.
Veja, então, o que significa cada coluna das notificações disponíveis:
Prioridade no caminho feliz: se esta função estiver disponível, ela vai indicar a ordem de envio das mensagens seguindo a lógica do chamado “caminho feliz”. Você pode ler mais sobre ele aqui;
Nome da notificação: é o nome que damos para a notificação dentro do nosso painel;
Como reconhecemos o evento: em algumas integrações, deixamos documentada a maneira como elas são reconhecidas pelo nosso sistema. Isso acontece porque algumas delas podem ser personalizadas. Mas, se o reconhecimento não estiver disponível, pode ficar tranquilo pois isso não afeta qualquer usabilidade do sistema.
Atualizado em: 31/10/2023
Obrigado!