Quais dados posso receber do meu aluno nos webhooks?

Veja qual tipo de dado a EngagED fornece em cada webhook disparado

Podemos disparar os dados que foram coletados dentro da turma em que o aluno esteve realizando a inscrição. Para isso, certifique-se de que todos os dados que precisará contar estejam sendo solicitados para o aluno durante seu processo de matrícula.

Alguns campos são padrão da EngagED, e nesses casos, possuímos um conjunto de valores aplicáveis para cada campo se for respondido pelo aluno.

id - identificador único do aluno.

status - status do aluno em questão, podendo variar entre form_waiting, contract_waiting, contract_completed, payment_waiting, payment_pending, onboarding

dt_inscricao - data em que foi iniciado a inscrição do aluno, no formato "YYYY-MM-DD HH:mm:ss"

nm_pessoa - nome completo do aluno.

first_name - primeiro nome.

last_name - último nome.

e_mail - endereço de e-mail.

celular - número do celular.

cpf - número de cpf.

dt_nascimento - data de nascimento do aluno, no formato "YYYY-MM-DD".

rg - númro do rg.

orgao_emissor_rg - órgão emissor do rg do aluno.

numero_passaporte - número de passaporte

pais_nascimento - país de origem do aluno.

sexo - gênero

area_atuacao - área de atuação do aluno.

cargo - cargo do aluno.

empresa - empresa preenchida pelo aluno.

escolaridade - grau de escolaridade do aluno.

estado_civil - estado civil em que o aluno se encontra.

url_contrato - caso tenha contrato, o link de acesso ao contrato assinado pelo aluno.

codigo_contrato - código único que representa o contrato assinado pelo aluno na etapa de contrato.

ip_aceite_contrato - IP do aluno que assinou o contrato.

ua_aceite_contrato - user agent referente ao aluno que assinou o contrato.

data_aceite_contrato - data e horário em que foi dado o aceite do contrato pelo aluno.

educacao[] - enviamos um array com variáveis referentes à formação do aluno, podendo conter os seguintes campos:

  • instituicao - nome da instituição de formação do aluno caso preenchido.

  • curso - curso de formação do aluno caso preenchido.

  • inicio - início da formação, no formato 'YYYY-MM-DD', se preenchido.

  • fim - fim da formação, no formato 'YYYY-MM-DD', se preenchido.

  • certificados[] - url - array contendo os links de acesso ao certificado de conclusão de curso do aluno, se for anexado.

  • historico_escolar[] - url - array contendo os links de acesso ao histórico escolar do aluno, se for anexado.

Campos de endereço

rua - nome da rua (endereço) preenchido pelo aluno, se houver.

numero - numero (endereço) preenchido, se houver.

complemento - complemento de endereço, se houver.

bairro - bairro, se houver.

nm_cidade_endereco - nome da cidade (endereço), se houver.

cd_uf_endereco - estado (endereço), se houver.

cep - cep (endereço), se houver.

Campos de Pagamento

fatura_id - Código identificador único da fatura.

status_pagamento - Status de pagamento.

valor - Valor total do pagamento (sem descontos aplicados.

juros - Valor de juros aplicado (se houver, caso o aluno tenha optado por pagamento parcelado).

desconto - Desconto, se houver, em casos de aplicação de voucher por exemplo.

tipo_desconto - Qual o tipo de desconto aplicado, voucher por exemplo.

reembolso - Se algum valor do valor total foi reembolsado.

total - Total recebido.

metodo_pagamento - Método de pagamento optado pelo aluno.

paid_date - Data em que o pagamento foi realizado.

Campos de Pagamento - Boleto Bancário

url_boleto - Link de acesso ao boleto bancário emitido pelo aluno.

cd_barras_boleto - Código de barras do boleto.

vencimento_boleto - Data de vencimento do boleto bancário, no formato "YYYY-MM-DD".

Campos de Pagamento - Cartão de Crédito

parcelas_cartao - Quantidade de parcelas optado no pagamento.

bandeira_cartao - Bandeira do cartão de crédito.

nome_cartao - Nome do proprietário do cartão de crédito.

primeiros_digitos_cartao - Primeiros 4 dígitos do cartão.

ultimos_digitos_cartao - Últimos 4 dígitos do cartão.

vencimento_cartao - Data de vencimento do cartão de crédito.

Campos de Pagamento - Dados do pagador

nm_pagador - Nome de quem realizou o pagamento.

tp_registro_fiscal - CPF ou CNPJ

numero_fiscal - Numero do CPF ou do CNPJ de quem pagou.

pais_pagador - País de quem realizou o pagamento.

Campos Customizados

campos_customizados[] - array contendo todos os campos customizados inseridos para o funil, se houver.

Para campos personalizados: Os valores de resultado dos campos personalizados que forem configurados para solicitar ao aluno serão enviados exatamente da maneira como o aluno preencheu.

Curso e Turma

curso_categoria - categoria do curso

curso_modalidade - modalidade do curso.

nm_curso - nome do curso.

turma_id - identificador único da turma.

nm_turma - nome da turma.