Integração via Webhook (Outbound) | Base de conhecimento

Veja como integrar:

Acesse sua conta na Membox pelo link: https://app.membox.io/login
No menu lateral esquerdo, clique em Integrações e depois clique em Adicionar nova.
Selecione a opção Webhook (Outbound) para iniciar a configuração.
URL de destino: Informe a URL do sistema externo que irá receber os dados enviados pela Membox.
Essa URL será chamada automaticamente sempre que um evento configurado ocorrer.
Método HTTP: Selecione o método HTTP que será utilizado no envio da requisição.
Atualmente, os métodos disponíveis são:
- POST
- PUT
- PATCH
- GET
- DELETE
Headers (JSON opcional): Neste campo, você pode definir headers personalizados que serão enviados junto com o webhook, como tokens de autenticação ou identificadores do sistema.
O conteúdo deve estar em formato JSON válido.

Exemplo:
```
{   

"Authorization": "Bearer seu-token-aqui",   
"Content-Type": "application/json",   
"X-Source": "Membox",   
"X-Integration-Key": "sua-chave-opcional" 

}
```
Esses headers são úteis para autenticação, segurança e identificação da origem da requisição no sistema de destino.
Body do Webhook (Template JSON): Neste campo você define o payload do webhook, ou seja, o conteúdo que será enviado para o sistema externo.

A Membox utiliza templates JSON com placeholders dinâmicos, que são substituídos automaticamente pelos dados reais do aluno no momento do envio.

Placeholders disponíveis:

Você pode utilizar os seguintes placeholders no corpo do JSON:
- {{nome_aluno}} → Nome do aluno
- {{email_aluno}} → E-mail do aluno
- {{telefone_aluno}} → Telefone do aluno
- {{observacao_aluno}} → Observação cadastrada no perfil do aluno
- {{documento_aluno}} → Documento (CPF)
- {{tipo_acesso}} → Tipo de acesso (full ou custom)
- {{status_aluno}} → Status do aluno
  
  Além disso, o sistema envia estruturas completas de:
  
  tags → Lista de tags vinculadas ao aluno
  courses → Lista de cursos nos quais o aluno está inscrito (quando aplicável)
Exemplo de template JSON:
```
{ 

"student_name": "{{nome_aluno}}",
"student_email": "{{email_aluno}}",
"student_phone": "{{telefone_aluno}}",
"student_document": "{{documento_aluno}}",
"type_access": "{{tipo_acesso}}",
"status": "{{status_aluno}}"

}
```
Importante: após a substituição dos placeholders, o conteúdo precisa continuar sendo um JSON válido.

Você pode usar o botão Formatar JSON para validar e ajustar o formato.
Gatilhos da integração: Os gatilhos definem quando o webhook será disparado.
Você pode selecionar um ou mais eventos:

Eventos suportados:
- Cadastro de novos alunos (manual)
- Cadastro de novos alunos (importação)
- Cadastro de novos alunos (integração)
- Cadastro de novos alunos (auto inscrição)
- Atualização de cadastro do aluno
- Confirmação de cadastro do aluno (senha definida)
- Progresso de aula (aula marcada como concluída ou desmarcada)
- Progresso de módulo
- Progresso de curso
Sempre que um desses eventos ocorrer, o webhook será enviado automaticamente para a URL configurada.
Criação da integração: Após configurar todos os campos revise a URL, headers, body e gatilhos e clique em Criar integração.

A partir desse momento, o Webhook Outbound estará ativo e começará a enviar dados conforme os eventos configurados.
Observações importantes
- O envio de webhooks é automático e em tempo real.
- O sistema conta com mecanismo de rastreamento e observabilidade, registrando:
  - Tentativas de envio
  - Erros de requisição
  - Payloads enviados
- Campos não preenchidos no cadastro do aluno podem ser enviados como null ou string vazia.
- Você pode criar quantos webhooks forem necessários, de acordo com seus fluxos e integrações.

Suporte Membox

Se tiver dúvidas, sugestões ou críticas, entre em contato conosco pelo e-mail [email protected] ou pelo chat da plataforma.

Estamos à disposição para ajudar!

Gostou deste artigo? Deixe seu feedback com as reações abaixo 👇