Webhooks: Conectando o SuperSaaS a outros sites
Webhooks são retornos de chamada definidos pelo usuário que informam outros aplicativos ou sites sobre eventos que ocorrem na sua conta SuperSaaS quase em tempo real.
Alguns exemplos de como você pode usar um webhook:
- Quando um novo usuário se registra na sua conta SuperSaaS, inscreva-o em uma lista de e-mails do MailChimp
- Quando um novo usuário se registra, envie um PDF com seus termos e condições para o e-mail dele
- Quando um novo agendamento é feito, gere uma fatura no QuickBooks ou Freshbooks
- Quando um novo agendamento é feito para uma aula específica, marque no Google Calendar do professor responsável
- Quando um agendamento estiver prestes a começar, envie uma notificação para o Slack ou um push para o seu celular
- Quando um usuário for movido da lista de espera para uma vaga confirmada, envie um SMS para ele
- Quando um e-mail for enviado, redirecione-o para enviar e-mail via outro servidor de e-mail
Configure automaticamente os webhooks usando Zapier.com ou Make
Você pode usar o Zapier.com ou o Make para criar links interativos entre centenas de sites conhecidos e o SuperSaaS, sem precisar programar. Tanto o Zapier quanto o Make oferecem uma versão de teste e um plano gratuito para pequenos usuários.
Deve ser relativamente simples criar webhooks a partir dos exemplos prontos, mas você pode encontrar informações detalhadas abaixo caso deseje mais controle aplicando filtros para apenas certos eventos.
→ Novo usuário para lista do MailChimp → Novo agendamento para Google Calendar → Novo agendamento gera fatura no QuickBooks → Novo agendamento para filtro de e-mailsGatilhos Suportados
Há vários eventos que você pode monitorar. Alguns eventos podem ser monitorados como um evento “novo” ou “modificado”. O evento “modificado” inclui todas as alterações, portanto também é acionado em “novo” e “excluído”. Portanto, se você configurar tanto “Novo usuário” quanto “Usuário modificado”, ambos os webhooks serão acionados quando um novo usuário se registrar. Observe que, se você configurou seu agendamento para não exigir cadastro, então você nunca verá um gatilho de “Novo usuário”, apenas um de “Novo agendamento”.
| Gatilho | Causado por… |
|---|---|
| Novo usuário | Acionado quando um usuário se registra na sua conta |
| Usuário modificado | Acionado quando o usuário atualiza suas informações de cadastro ou o administrador faz isso por ele. |
| Novo agendamento | Acionado quando um usuário ou o administrador cria um agendamento no agendamento especificado. |
| Agendamento modificado | Acionado por todas as possíveis alterações em um agendamento, incluindo “Novo”, “Excluir”, “Movido da lista de espera”, “Pagamento recebido”, etc. (Veja a lista completa abaixo) |
| Novo formulário independente | Acionado quando um formulário independente é preenchido. Observe que ele não é acionado quando um formulário está anexado a um agendamento; nesse caso, o webhook do agendamento será acionado. |
| Formulário independente atualizado | Acionado a cada modificação em um formulário independente (formulários integrados acionam “Agendamento modificado” ou “Usuário modificado”) |
| Enviar e-mail | Acionado por todos os e-mails enviados da sua conta, incluindo e-mails de “Recuperar senha”, etc. Útil para enviar e-mails por meio do seu próprio servidor. O e-mail não será mais enviado por nós se este webhook estiver ativo. |
| Lembrete Ações de acompanhamento | Acionado por lembretes ou mensagens de acompanhamento. O lembrete ou a mensagem de acompanhamento não será mais enviada por nós se o webhook estiver ativo. |
| Compra | Acionado quando um usuário realiza uma compra na sua loja. Também é acionado se você criar uma compra manualmente. |
Filtrando eventos
Quando você conecta dois serviços usando o Zapier ou o Make, é possível filtrar os eventos. Alguns exemplos de como usar filtros:
- Enviar uma notificação por SMS apenas quando alguém for movido da lista de espera, não para toda alteração de agendamento
- Notificar um professor apenas se a nova reserva for de uma aula ministrada por ele, ignorando outras reservas no mesmo agendamento
- Enviar uma notificação à administração apenas se o valor da reserva for superior a R$100
Quando você cria um novo webhook, o Zapier/Make solicitará um objeto de exemplo do SuperSaaS. Esse objeto de exemplo lista os campos disponíveis e alguns conteúdos de exemplo. Os campos enviados pelo webhook dependem dos campos habilitados na sua conta e se um formulário personalizado está anexado. Existem campos como “evento” e “role” incluídos na maioria dos gatilhos, que podem ser usados para filtrar os eventos. Por exemplo, você pode filtrar apenas os gatilhos que contenham o valor “delete” no campo “evento”.
| Gatilho | Valores possíveis do campo “evento” |
|---|---|
| Novo usuário | novo |
| Usuário modificado | novo, alterar, excluir |
| Novo agendamento | criar |
| Agendamento modificado | criar, editar, colocar, pendente, destruir, restaurar, aprovar, reverter |
| Novo formulário | novo |
| Formulário modificado | novo, editar, destruir, restaurar |
| Lembrete / Acompanhamento | lembrete, acompanhamento |
| Compra | Compra |
| Campo “Role” | Quem acionou o evento… | |
|---|---|---|
| 0 | Anônimo | Não está logado |
| 1 | Logado com senha compartilhada | |
| 2 | Validado usando verificação de intervalo de IP | |
| 3 | Usuário regular | |
| 4 | Superusuário | |
| 5 | Administrador ou Revendedor | |
| 7 | Sistema ou gateway de pagamento | |
Ao criar ou modificar um agendamento que inclua pagamento, os campos “status” e “mensagem de status” permitem que você refine os eventos com base na lista completa de códigos de status. Por exemplo, você pode configurar um filtro para atuar apenas em mensagens de agendamentos que foram reembolsados.
Webhooks com n8n auto-hospedado
Outra opção é usar webhooks com o n8n auto-hospedado. Isso requer conhecimento técnico avançado e é recomendado apenas para usuários experientes do n8n que tenham familiaridade com tópicos como configuração e segurança de servidores, configuração de recipientes e gerenciamento de recursos de aplicação. Para mais informações sobre como usar o n8n auto-hospedado, consulte a documentação de webhooks para desenvolvedores.
Configuração manual de webhooks (avançado)
Criar um webhook sem usar o Zapier ou o Make requer habilidades em desenvolvimento web. Você pode configurar os webhooks para enviá-los diretamente ao seu próprio servidor ou modificar o conteúdo (carga útil) que eles contêm. Os detalhes podem ser encontrados na documentação de webhooks para desenvolvedores.