Uma empresa da
Cogna Educação

Entrar
Cadastre-se grátis

Webhooks Play

O Webhooks Play é uma ferramenta que permite a integração de eventos do sistema com outros sistemas externos. Através de requisições HTTP, é possível enviar informações sobre eventos ocorridos no sistema para um servidor externo, permitindo a execução de ações personalizadas.

Estrutura Completa

Atributo Tipo Descrição Valor Padrão Valores Aceitos
type Texto Indica a origem da solicitação enviada webhook
event Texto Indica o tipo do evento da solicitação enviada
  • classEndDate: Uma lição foi concluída
  • moduleEndDate: Um módulo foi concluído
  • courseEndDate: Um curso foi concluído
  • certificateDate: Data de Emissão do Certificado
  • inactivityTime: Indica tempo de inatividade do aluno
  • courseProgress: Indica o progresso do aluno nos cursos
sub_event Texto Indica os subeventos da solicitação enviada null Ver mais em: Subeventos
date Texto Indica a data em que a solicitação foi enviada. (Padrão: Y-m-d H:i:s)
student Object Contém as informações básicas do estudante Ver mais em: Estrutura do objeto student
course Object Contém as informações do curso sendo realizado Ver mais em: Estrutura do objeto course
module Object Contém as informações do curso sendo realizado Ver mais em: Estrutura do objeto module
registration Object Contém as informações de matrícula do aluno Ver mais em: Estrutura do objeto registration
class Object Contém as informações do curso sendo realizado Ver mais em: Estrutura do objeto class
JSON 
{
    "type": "webhook",
    "event": "moduleEndDate",
    "sub_event": null,
    "date": "2024-10-29 15:23:52",
    "student": {
        "name": "Aluno teste",
        "email": "email@teste.com.br",
        "phone": "11999999999"
    },
    "course": {
        "title": "Curso teste",
        "description": "Descrição curso teste",
        "short_description": "Short desc do curso",
        "category": "Categoria teste",
        "status": "published",
        "lessons_count": 4,
        "rating": 5,
        "lessons_completed_count": 2,
        "percentage_to_complete": 20,
        "percentage_completed": 80
    },
    "module": {
        "title": "Módulo teste",
        "lessons_count": 3,
        "lessons_completed_count": 1,
        "is_conditional": false
    },
    "class": {
        "title": "Aula teste"
    }
}

Objeto student

Atributo Tipo Descrição Exemplo
name Texto Nome do Aluno Aluno Teste
email Texto Email do Aluno email@gmail.com
phone Texto Telefone do Aluno 16999999999
JSON 
"student": {
    "name": "Aluno teste",
    "email": "email@teste.com.br",
    "phone": "11999999999"
}

Objeto course

Atributo Tipo Descrição Exemplo
title Texto Título do curso Curso teste
description Texto Descrição completa do curso Descrição curso teste
short_description Texto Descrição curta do curso Short desc do curso
category Texto Categoria do curso Categoria teste
status Texto Status de publicação do curso published
lessons_count Número Total de lições do curso 4
rating Número Avaliação média do curso 5
lessons_completed_count Número Total de lições concluídas 2
percentage_to_complete Número Percentual para completar 20
percentage_completed Número Percentual já concluído 80
JSON 
"course": {
    "title": "Curso teste",
    "description": "Descrição curso teste",
    "short_description": "Short desc do curso",
    "category": "Categoria teste",
    "status": "published",
    "lessons_count": 4,
    "rating": 5,
    "lessons_completed_count": 2,
    "percentage_to_complete": 20,
    "percentage_completed": 80
}

Objeto module

Atributo Tipo Descrição Exemplo
title Texto Título do módulo Módulo teste
lessons_count Número Total de lições no módulo 3
lessons_completed_count Número Total de lições concluídas no módulo 1
is_conditional Booleano Indica se o módulo é condicional false
JSON 
"module": {
    "title": "Módulo teste",
    "lessons_count": 3,
    "lessons_completed_count": 1,
    "is_conditional": false
}

Objeto registration

Atributo Tipo Descrição Exemplo
id Número ID da Matrícula 1547
expiration_date Texto Data em que o acesso foi expirado 2025-02-21 00:00:00
expired Texto Status da matrícula expired
JSON 
"registration": {
    "id": 1547,
    "expiration_date": "2025-02-21 00:00:00",
    "status": "expired"
}

Objeto class

Atributo Tipo Descrição Exemplo
title Texto Título da aula Aula teste
JSON 
"class": {
    "title": "Aula teste"
}

Subeventos

Os subeventos são utilizados para indicar especificamente a finalidade da requisição, complementando a informação do evento. Abaixo estão listados os subeventos para cada evento principal.

Indicador de Conclusão de Aula

Atributo Tipo Valores Aceitos
sub_event Texto – 1DayOfInactivity: Representa um dia de inatividade.
– 5DaysOfInactivity: Representa cinco dias de inatividade.
– 10DaysOfInactivity: Representa dez dias de inatividade.
– 20DaysOfInactivity: Representa vinte dias de inatividade.
– 30DaysOfInactivity: Representa trinta dias de inatividade.
– 60DaysOfInactivity: Representa sessenta dias de inatividade.
– 90DaysOfInactivity: Representa noventa dias de inatividade.
JSON 
{
    "type": "webhook",
    "event": "inactivityTime",
    "sub_event": "30DaysOfInactivity",
    "date": "2024-10-29 15:51:57",
    "student": {
        "name": "Aluno teste",
        "email": "email@teste.com.br",
        "phone": "11999999999"
    }
}

Indicador de Progresso

Atributo Tipo Valores Aceitos
sub_event Texto – 25Progress: Indica que 25% do progresso foi alcançado.
– 50Progress: Indica que 50% do progresso foi alcançado.
– 75Progress: Indica que 75% do progresso foi alcançado.
– 100Progress: Indica que 100% do progresso foi alcançado.
JSON

A estrutura do JSON é a completa, mudando somente o event e o sub_event. Ver mais em: Estrutura Completa

Webhooks Específicos

Aqui constam as estruturas que são específicas de acordo com o Webhook desejado.

Expiração de Acesso do Aluno

Atributo Tipo Descrição
course Object Informações sobre o curso o qual o aluno está matriculado
class Object Informações sobre a turma a qual o aluno está associado
registration Object Informações sobre a matrícula do aluno
JSON 
{
    "course" : {
        "title": "Curso 2"
    },
    "class": {
        "title"； "Turma 2 Expiração"
    },
    "registration": {
        "id": 1757,
        "expiration_date" : "2025-02-20 11:50:01".
        "status": "expired"
    },
    "type" : "webhook"
    "event" : "studentExpirationAccess"
    "sub_event": null,
    "date": "2025-02-20 08:50:01",
    "student" : {
        "name" : "Membro 1150",
        "email" : "membro1150@maildrop.cc",
        "phone": "(11) 5656-5656"
    }
}
voomp logo
voomp logo
Sou Aluno
Sou Produtor
Voomp Footer

Depoimento Ambiental Pro

Desde o início, tivemos uma excelente experiência e temos um contato muito próximo com os tomadores de decisão da plataforma. Eles sempre estão dispostos a ouvir nossas sugestões e implementá-las rapidamente, o que é realmente raro de se encontrar em outras plataformas.

 

Além disso, o atendimento da Voomp é simplesmente excepcional. Nunca tivemos um contato tão próximo e personalizado com outra plataforma, e isso tem sido fundamental para o sucesso de nossos cursos online. Eles estão sempre dispostos a ajudar e a resolver qualquer problema de maneira rápida e eficiente.

 

Outro ponto positivo da Voomp é a possibilidade de certificar nossos cursos pelo MEC, o que é muito valioso para nós e para nossos alunos. Isso mostra a seriedade e a qualidade da plataforma, e tem sido uma diferença fundamental na escolha da Voomp em relação a outras opções no mercado.

 

Em resumo, não poderíamos estar mais satisfeitos com a Voomp. Eles são uma equipe incrível e estão sempre procurando aprimorar a experiência dos usuários. Não hesitamos em recomendá-los a outras pessoas e em continuar trabalhando com eles no futuro.

Fale com o time Creators!