Uma vez entendido o significado de webhooks e como eles se aplicam no dia-a-dia, o próximo passo é configurá-los em sua conta.

O primeiro passo para isso é definir qual é ou quais serão os gatilhos que irá utilizar para configurar o webhook em sua conta.

Gatilhos

Os gatilhos são os momentos em que se deseja realizar os disparos das requisições para seu sistema.

Atualmente a EngagED conta com os seguintes gatilhos, podendo ser combinados para que seu webhook seja utilizado.

lead-status-changed

Sempre que um aluno mudar de status ao longo de sua jornada de inscrição, este gatilho será disparado. Os diferentes status que podem ser atribuídos ao longo dessa jornada são:

  • form_waiting : assim que entra na etapa de preenchimento de dados pessoais.
  • contract_waiting : ao entrar na etapa de aceite do contrato.
  • contract_completed : assim que aceitou o contrato.
  • payment_waiting : entrou na etapa de pagamento, onde ainda não optou por cartão ou boleto.
  • payment_pending : gerou o boleto bancário.
  • onboarding : caso tenha concluído a inscrição e chegado até a última etapa do funil.

lead-status-on-class-confirmation

Sempre que houver a confirmação de uma turma, será disparado um gatilho para cada um dos leads da turma em questão.

lead-status-on-class-cancelation

Sempre que houver o cancelamento de uma turma, será disparado um gatilho para cada um dos leads da turma em questão.

Filtros

Para cada um dos gatilhos, é possível aplicar um filtro para evitar de que todos os gatilhos referentes à aquela condição sejam enviados.

Por exemplo, suponhamos que queira disparar um webhook com o gatilho de lead-status-changed para toda vez que um aluno mudar de status, mas que este disparo seja realizado apenas quando este aluno finalizar seu processo de matrícula. Neste caso, é possível configurar um filtro para que a condição do status do aluno seja de "onboarding".

O filtro atualmente é baseado no status do aluno, podendo ser configurado para satisfazer os diferentes status que um aluno pode assumir (explicado na listagem acima da seção "lead-status-changed"), podendo ser configurado para: form_waiting, contract_waiting, contract_completed, payment_waiting, payment_pending, onboarding.

URL

Todo disparo é realizado postando dados no formato JSON. Para isso, precisamos que nos forneça a URL que iremos realizar a requisição POST para enviar os dados em cada gatilho.

E se meu sistema estiver fora do ar e eu não receber a requisição disparada pelo webhook da EngagED?

Quantidade de tentativas

Não se preocupe, para todo webhook você deve definir a quantidade de tentativas que iremos realizar até obter a resposta de sucesso na requisição.

Resposta padrão de sucesso

Além disso, você pode nos fornecer qual a resposta padrão de sucesso para as requisições de nossos webhooks, por exemplo:

  • { "success" : "1" }
  • { "status" : "success" }
  • entre outros

Tempo entre uma tentativa e outra

Além da quantidade de tentativas, defina também o tempo (em minutos) entre uma tentativa de requisição e outra em casos de falha.

Para saber quais são as informações que podemos enviar à respeito do aluno, clique aqui e veja esta publicação em nossa central de ajuda.

Encontrou sua resposta?