​

📈 Tipo de dados do payload:

Usuário:
	ID: number
	Nome: string
	Email: string
	Instituição:
		ID: number
		Escolas:
			ID: number
			ID da Função: number
			Criado em: string (formato: "dd/MM/yyyy HH:mm:ss")
			Atualizado em: string (formato: "dd/MM/yyyy HH:mm:ss")
	CPF: string
	Apelido: null ou string

​

Detalhes do Evento

• Nome: Nome do evento em formato de texto.
• Slug: Identificador único do evento em formato de texto.
• Enviar em: Data e hora do evento no formato “yyyy-MM-dd HH:mm:ss”.
• Ação: Ação associada ao evento em formato de texto.

​

Dados do Usuário:

• ID: Identificador numérico do usuário.
• Nome: Nome do usuário em formato de texto.
• Email: Endereço de email do usuário em formato de texto.
  • Instituição:
    • ID: Identificador numérico da instituição.
      • Escolas:
        • ID: Identificador numérico da escola.
        • ID da Função: Identificador numérico da função do usuário na escola.
        • Criado em: Data e hora de criação no formato “dd/MM/yyyy HH:mm:ss”.
        • Atualizado em: Data e hora de atualização no formato “dd/MM/yyyy HH:mm:ss”.
• Apelido: Valor nulo (null) ou apelido do usuário em formato de texto.
• CPF: Número de CPF do usuário em formato de texto.

​

📈 Dados do evento:

Nome: Newsletter - Aceitar newsletter
Slug: newslatter.created
Enviar em: 2023-07-03 12:56:48
Ação: accept_newslatter

​

Ação para disparar o evento:

O webhook será acionado quando o usuário optar por participar da newsletter, enviando os dados relevantes para que a instituição possa adicionar o usuário à lista de assinantes. Esses dados podem incluir informações como nome, endereço de e-mail, informações relevantes para a newsletter.

​

Payload/Exemplo de resposta:

O sistema deve responder com um código HTTP 200 OK se a operação for bem-sucedida. Se houver algum erro, o sistema deve responder com um código HTTP 4xx ou 5xx e uma mensagem de erro.

{
  "event": {
    "name": "Newsletter - Aceitar newsletter",
    "slug": "newslatter.created",
    "send_at": "2023-07-03 12:56:48",
    "acao": "accept_newslatter"
  },
  "data": {
    "user": {
      "id": 123456,
      "name": "Nome do aluno",
      "email": "aluno@toolzz.com",
      "institution": [
        {
          "id": 12345,
          "schools": [
            {
              "id": 123456789,
              "role_id": 4,
              "created_at": "03/07/2023 12:52:18",
              "updated_at": "03/07/2023 12:52:18"
            }
          ]
        }
      ],
      "cpf": "123.456.789-99",
      "nickname": null
    }
  }
}

​

🔒 Segurança:

Certifique-se de que a URL de destino esteja correta antes de começar a enviar payloads. Verifique se os parâmetros enviados estão corretos e completos. Certifique-se de que os destinatários do webhook estejam corretos e sejam válidos. Registre e monitore todas as chamadas de webhook para fins de auditoria e rastreamento de problemas.

​

⚠️ Códigos de Erro:

O sistema deve responder com um código HTTP 200 OK se a operação for bem-sucedida. Se houver algum erro, o sistema deve responder com um código HTTP 4xx ou 5xx e uma mensagem de erro.

​

💬 Glossário:

• Payload: dados que são enviados para o webhook.
• Slug: um identificador único para o evento.
• Autenticação: processo de verificação da identidade do remetente de uma solicitação.