​
📈 Dados a serem exportados:

  • event: objeto contém informações sobre o evento que acionou o webhook.
  • name: Nome do evento, neste caso “Membros - Novo cadastro”.
  • slug: Um identificador único para o evento, neste caso “members.created”.
  • send_at: Timestamp quando o evento foi acionado, neste caso “2023-03-16 11:38:00”.
  • acao: Uma descrição da ação realizada, neste caso “cadastro”.
  • objeto “data”: contém os dados do payload para o evento:
  • objeto “user”: contém informações sobre o usuário recém-registrado:
  • id: Identificador único para o usuário.
  • name: O nome do usuário, neste caso.
  • email: O endereço de e-mail do usuário.
  • date_of_birth: data de nascimento do usuário.
  • institution: informações sobre a instituição à qual o usuário pertence, neste caso um “id” e um array “schools” contendo um objeto com “id” e “role_id” de 4.
  • cpf: O CPF (Cadastro de Pessoa Física) do usuário.
  • cnpj: o CNPJ (Cadastro Nacional da Pessoa Jurídica) do usuário.
  • nickname: O apelido do usuário.
  • uuid: O UUID (identificador único universal) do usuário.
  • phone: telefone do usuário.
  • address: informações relacionada ao endereço do usuário.
  • cep: o (Código de Endereçamento Postal) do usuário.
  • uf: (Unidade Federativa) ou estado brasileiro do usuário.
  • cidade: cidade do usuário.
  • bairro: bairro do usuário.
  • logradouro: endereço do usuário.
  • numero: número do usuário.
  • complemento: complemento do usuário.
  • formulario_respostas é um array de objetos contendo as respostas do formulário do usuário. Neste caso, contém um objeto com uma chave “qual_sua_cor_favorita” e um valor “azul”.

​
📈 Dados do evento:

Slug: members.created
Tipo de autenticação: N/A
Método HTTP: POST

​
Ação para disparar o evento:

  • Quando um usuário faz o preenchimento do formulário de cadastro no sistema da “Instituição” com todas a informações válida, e aciona o “Call-to-action (CTA)” de cadastrar.
  • Quando um usuário faz o preenchimento do formulário cadastro no sistema da “Unidade” com todas a informações válida, e aciona o “Call-to-action (CTA)” de cadastrar.
  • Quando o administrador faz preenchimento de cadastro do usuário no sistema em “Novos Membros” com todas a informações válida, e aciona o “Call-to-action (CTA)” de cadastrar.
  • Quando o administrador faz preenchimento de cadastro do usuário no sistema em “Novos Membros” com todas a informações válida, e aciona o “Call-to-action (CTA)” de cadastrar.
  • Quando o Gestor faz preenchimento de cadastro do usuário no sistema em “Novos Membros” com todas a informações válida, e aciona o “Call-to-action (CTA)” de cadastrar.
  • Quando o Professor faz preenchimento de cadastro do usuário no sistema em “Novos Membros” com todas a informações válida, e aciona o “Call-to-action (CTA)” de cadastrar.
  • Quando o cadastro do usuário é feito via “API” com todas a informações válida.
  • Quando o cadastro do usuário é feito via “CSV” com todas a informações válida.

​
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.
payload7.json
{  
  "event": {  
    "name": "Membros - Novo cadastro",  
    "slug": "members.created",  
    "send_at": "2023-03-16 11:38:00",  
    "acao": "cadastro"  
  },  
  "data": {  
    "user": {  
      "id": 88111131,  
      "name": "Aluno",  
      "email": "aluno@gmail.com",  
      "institution": [  
        {  
          "id": 5125342498,  
          "schools": [  
            {  
              "id": 19123424393,  
              "role_id": 4,  
              "created_at": "16/03/2023 11:37:36",  
              "updated_at": "16/03/2023 11:37:36"  
            }  
          ]  
        }  
      ],  
      "cpf": "111.222.333-01",  
      "cnpj": "67.124.784/0001-30",
      "nickname": null,  
      "uuid": null,
  		"phone": "(12) 3 1231-3212",
  		 "address": {
        "cep": "05608-015",
        "uf": "SP",
        "cidade": "Osasco",
        "bairro": "Cidade Jardim",
        "logradouro": "Praça Professor José de Melo Pimenta",
        "numero": "140",
        "complemento": "casa"
      }
    },  
    "formulario_respostas": [  
      {  
        "qual_sua_cor_favorita": "azul"  
      }  
    ]  
  }  
}

​
🔒 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.