Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: added alpaclass student_created event #16

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

feat: added alpaclass student_created event #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a54a4aa
feat: added alpaclass student_created event
renatovdemoura Jun 14, 2024
e8afbfc
feat: adc 3 events
Larissa1222 Jun 18, 2024
c05c1f7
feat: add events pt 2
Larissa1222 Jun 18, 2024
4013289
feat: rename files, fix grammar
Larissa1222 Jun 18, 2024
c3d9706
feat: field type number to string
Larissa1222 Jun 18, 2024
fd0d3d1
feat: include course on lessons payload
Larissa1222 Jun 18, 2024
df70aa9
atualizar student course last seen at
Larissa1222 Jun 20, 2024
67f1beb
feat: alinhar a doc
Larissa1222 Jun 21, 2024
830d48b
Merge branch 'feature-alp-2978-student-events' of github.com:eduzz/ed…
Larissa1222 Jun 21, 2024
230c8bc
feat: substituir ids por hash
Larissa1222 Jun 24, 2024
4495f66
Merge pull request #17 from eduzz/feature-alp-2978-student-events
renatovdemoura Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,23 @@ Os eventos disponíveis atualmente são os seguintes:
- **[lesson_watched](./events/nutror/lesson_watched.md)**
- **[module_completed](./events/nutror/module_completed.md)**
- **[notation_created](./events/nutror/notation_created.md)**

- **AlpaClass**
- **[student_created](./events/alpaclass/student_created.md)**
- **[student_certificate_accessed](./events/alpaclass/student_certificate_accessed.md)**
- **[student_comment_created](./events/alpaclass/student_comment_created.md)**
- **[student_course_finished](./events/alpaclass/student_course_finished.md)**
- **[student_course_unfinished](./events/alpaclass/student_course_unfinished.md)**
- **[student_course_last_seen_at](./events/alpaclass/student_course_last_seen_at.md)**
- **[student_module_finished](./events/alpaclass/student_module_finished.md)**
- **[student_module_unfinished](./events/alpaclass/student_module_unfinished.md)**
- **[student_lesson_finished](./events/alpaclass/student_lesson_finished.md)**
- **[student_lesson_unfinished](./events/alpaclass/student_lesson_unfinished.md)**
- **[student_lesson_marked_as_favorite](./events/alpaclass/student_lesson_marked_as_favorite.md)**
- **[student_lesson_unmarked_as_favorite](./events/alpaclass/student_lesson_unmarked_as_favorite.md)**
- **[student_lesson_last_seen_at](./events/alpaclass/student_lesson_last_seen_at.md)**



## Como configurar um webhook

Expand Down
43 changes: 43 additions & 0 deletions events/alpaclass/student_certificate_accessed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Aluno acessa o certificado

## Exemplo

```json
{
"id": "4c832x3ynl8dwe7454941xzr5",
"event": "alpaclass.student_certificate_accessed",
"sentDate": "2024-06-12T12:00:10.000Z",
"data": {
"student": {
"id": "457391c9c82bfdcbb4947278c0401e41",
"name": "Fulano da Silva",
"email": "fulano.silva@email.com"
},
"course": {
"id": "046d47672cf6212d201d6e8b0c191e73",
"name": "Day trade para iniciantes",
},
"team": {
"id": "16943848cc6495142a8e3011d0173252",
"name": "Escola de Teste",
},
"certificateUrl": "https://certificados.alpaclass.../ZJ1zjj/certificado.pdf",
}
}
```

## Dados enviados

| Campo | Tipo | Descrição |
|-------------------------|--------|--------------------------------------------------|
| id | string | Id do evento |
| event | string | Nome do evento (student_certificate_accessed) |
| sentDate | string | Data do envio do evento |
| data.student.id | string | Id do aluno na escola |
| data.student.name | string | Nome do aluno |
| data.student.email | string | E-mail do aluno |
| data.course.id | string | Id do curso |
| data.course.name | string | Nome do curso |
| data.team.id | string | Id da escola |
| data.team.name | string | Nome da escola |
| data.certificateUrl | string | Url do certificado |
54 changes: 54 additions & 0 deletions events/alpaclass/student_comment_created.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Aluno comentou na aula
## Exemplo
```json
{
"id": "4c832x3ynl8dwe7454941xzr5",
"event": "alpaclass.student_comment_created",
"sentDate": "2024-06-12T12:00:10.000Z",
"data": {
"student": {
"id": "457391c9c82bfdcbb4947278c0401e41",
"name": "Fulano da Silva",
"email": "teste@email.com",
},
"lesson": {
"id": "6220a030be5f7a8c4760d3e9b4d5d9ee",
"name": "Aula 1 - Melhores ações do setor de energia",
},
"module": {
"id": "22884db148f0ffb0d830ba431102b0b5",
"name": "Módulo 1",
},
"course": {
"id": "046d47672cf6212d201d6e8b0c191e73",
"name": "Day trade para iniciantes",
},
"team": {
"id": "16943848cc6495142a8e3011d0173252",
"name": "Escola de teste",
},
"comment": "Adorei a aula, espero conseguir aplicar os aprendizados!",
}
}
```

## Dados enviados

| Campo | Tipo | Descrição |
|---------------------------|--------|---------------------------------------------|
| id | string | Id do evento |
| event | string | Nome do evento (student_comment_created) |
| sentDate | string | Data do envio do evento |
| data.student.id | string | Id do aluno na escola |
| data.student.name | string | Nome do aluno |
| data.student.email | string | E-mail do aluno |
| data.lesson.id | string | Id da aula |
| data.lesson.name | string | Nome da aula |
| data.module.id | string | Id do módulo |
| data.module.name | string | Nome do módulo |
| data.course.id | string | Id do curso |
| data.course.name | string | Nome do curso |
| data.team.id | string | Id da escola |
| data.team.name | string | Nome da escola |
| data.comment | string | Conteúdo do comentário |

41 changes: 41 additions & 0 deletions events/alpaclass/student_course_finished.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Aluno concluiu o curso
## Exemplo
```json
{
"id": "4c832x3ynl8dwe7454941xzr5",
"event": "alpaclass.student_course_finished",
"sentDate": "2024-06-12T12:00:10.000Z",
"data": {
"student": {
"id": "457391c9c82bfdcbb4947278c0401e41",
"name": "Fulano da Silva",
"email": "teste@email.com",
},
"course": {
"id": "046d47672cf6212d201d6e8b0c191e73",
"name": "Day trade para iniciantes",
},
"team": {
"id": "16943848cc6495142a8e3011d0173252",
"name": "Escola de teste",
},
}
}
```

## Dados enviados

| Campo | Tipo | Descrição |
|---------------------------|--------|---------------------------------------------|
| id | string | Id do evento |
| event | string | Nome do evento (student_course_finished) |
| sentDate | string | Data do envio do evento |
| data.student.id | string | Id do aluno na escola |
| data.student.name | string | Nome do aluno |
| data.student.email | string | E-mail do aluno |
| data.course.id | string | Id do curso |
| data.course.name | string | Nome do curso |
| data.team.id | string | Id da escola |
| data.team.name | string | Nome da escola |


39 changes: 39 additions & 0 deletions events/alpaclass/student_course_last_seen_at.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Ultimo acesso do aluno no curso
## Exemplo
```json
{
"id": "4c832x3ynl8dwe7454941xzr5",
"event": "alpaclass.student_course_last_seen_at",
"sentDate": "2024-06-12T12:00:10.000Z",
"data": {
"student": {
"id": "457391c9c82bfdcbb4947278c0401e41",
"name": "Fulano da Silva",
"email": "teste@email.com",
},
"course": {
"id": "046d47672cf6212d201d6e8b0c191e73",
"name": "Day trade para iniciantes",
},
"team": {
"id": "16943848cc6495142a8e3011d0173252",
"name": "Escola de teste",
},
}
}
```

## Dados enviados

| Campo | Tipo | Descrição |
|---------------------------|--------|---------------------------------------------|
| id | string | Id do evento |
| event | string | Nome do evento (student_course_last_seen_at)|
| sentDate | string | Data do envio do evento |
| data.student.id | string | Id do aluno na escola |
| data.student.name | string | Nome do aluno |
| data.student.email | string | E-mail do aluno |
| data.course.id | string | Id do curso |
| data.course.name | string | Nome do curso |
| data.team.id | string | Id da escola |
| data.team.name | string | Nome da escola |
40 changes: 40 additions & 0 deletions events/alpaclass/student_course_unfinished.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Aluno desmarca como concluido o curso
## Exemplo
```json
{
"id": "4c832x3ynl8dwe7454941xzr5",
"event": "alpaclass.student_course_unfinished",
"sentDate": "2024-06-12T12:00:10.000Z",
"data": {
"student": {
"id": "457391c9c82bfdcbb4947278c0401e41",
"name": "Fulano da Silva",
"email": "teste@email.com",
},
"course": {
"id": "046d47672cf6212d201d6e8b0c191e73",
"name": "Day trade para iniciantes",
},
"team": {
"id": "16943848cc6495142a8e3011d0173252",
"name": "Escola de teste",
},
}
}
```

## Dados enviados

| Campo | Tipo | Descrição |
|---------------------------|--------|---------------------------------------------|
| id | string | Id do evento |
| event | string | Nome do evento (student_course_unfinished) |
| sentDate | string | Data do envio do evento |
| data.student.id | string | Id do aluno na escola |
| data.student.name | string | Nome do aluno |
| data.student.email | string | E-mail do aluno |
| data.course.id | string | Id do curso |
| data.course.name | string | Nome do curso |
| data.team.id | string | Id da escola |
| data.team.name | string | Nome da escola |

43 changes: 43 additions & 0 deletions events/alpaclass/student_created.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Aluno cadastrado na escola

## Exemplo

```json
{
"id": "4c832x3ynl8dwe7454941xzr5",
"event": "alpaclass.student_created",
"sentDate": "2024-06-12T12:00:10.000Z",
"data": {
"student": {
"id": "457391c9c82bfdcbb4947278c0401e41",
"name": "Fulano da Silva",
"email": "fulano@eduzz.com",
"document": "123.456.789-00",
"phone": "11999999999",
"createdAt": "2024-06-12T12:00:00.000Z",
"locale": "pt_BR",
},
"team": {
"id": "457391c9c82bfdcbb4947278c0401e41",
"name": "Escola Teste",
},
}
}
```

## Dados enviados

| Campo | Tipo | Descrição |
|---------------------------|--------|--------------------------------------------------|
| id | string | Id do evento |
| event | string | Nome do evento (student_created) |
| sentDate | string | Data do envio do evento |
| data.student.id | string | Id do aluno na escola |
| data.student.name | string | Nome do aluno |
| data.student.email | string | Email do aluno |
| data.student.document | string | Documento do aluno. Geralmente é o CPF |
| data.student.phone | string | Telefone/Celular do aluno |
| data.student.createdAt | string | Data em que o aluno foi cadastrado na escola |
| data.student.locale | string | Idioma do aluno |
| data.team.id | string | Id da escola |
| data.team.name | string | Nome da escola |
53 changes: 53 additions & 0 deletions events/alpaclass/student_lesson_finished.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Aluno marcou a aula como concluída

## Exemplo
```json
{
"id": "4c832x3ynl8dwe7454941xzr5",
"event": "alpaclass.student_lesson_finished",
"sentDate": "2024-06-12T12:00:10.000Z",
"data": {
"student": {
"id": "457391c9c82bfdcbb4947278c0401e41",
"name": "Fulano da Silva",
"email": "teste@email.com",
},
"lesson": {
"id": "6220a030be5f7a8c4760d3e9b4d5d9ee",
"name": "teste de aula com link",
},
"module": {
"id": "22884db148f0ffb0d830ba431102b0b5",
"name": "Módulo 1"
},
"course": {
"id": "046d47672cf6212d201d6e8b0c191e73",
"name": "Day trade para iniciantes"
},
"team": {
"id": "16943848cc6495142a8e3011d0173252",
"name": "Escola de Teste"
},
}
}
```

## Dados enviados

| Campo | Tipo | Descrição |
|---------------------------|--------|---------------------------------------------------|
| id | string | Id do evento |
| event | string | Nome do evento (student_lesson_finished) |
| sentDate | string | Data do envio do evento |
| data.student.id | string | Id do aluno na escola |
| data.student.name | string | Nome do aluno |
| data.student.email | string | Nome do aluno |
| data.lesson.id | string | Id da aula |
| data.lesson.name | string | Nome da aula |
| data.module.id | string | Id do módulo |
| data.module.name | string | Nome do módulo |
| data.course.id | string | Id do curso |
| data.course.name | string | Nome do curso |
| data.team.id | string | Id da escola |
| data.team.name | string | Nome da escola |

53 changes: 53 additions & 0 deletions events/alpaclass/student_lesson_last_seen_at.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Ultimo acesso do aluno na aula

## Exemplo
```json
{
"id": "4c832x3ynl8dwe7454941xzr5",
"event": "alpaclass.student_lesson_finished",
"sentDate": "2024-06-12T12:00:10.000Z",
"data": {
"student": {
"id": "457391c9c82bfdcbb4947278c0401e41",
"name": "Fulano da Silva",
"email": "teste@email.com",
},
"lesson": {
"id": "6220a030be5f7a8c4760d3e9b4d5d9ee",
"name": "teste de aula com link",
},
"module": {
"id": "422884db148f0ffb0d830ba431102b0b540",
"name": "Módulo 1"
},
"course": {
"id": "046d47672cf6212d201d6e8b0c191e73",
"name": "Day trade para iniciantes"
},
"team": {
"id": "16943848cc6495142a8e3011d0173252",
"name": "Escola de Teste"
},
}
}
```

## Dados enviados

| Campo | Tipo | Descrição |
|---------------------------|--------|---------------------------------------------------|
| id | string | Id do evento |
| event | string | Nome do evento (student_lesson_finished) |
| sentDate | string | Data do envio do evento |
| data.student.id | string | Id do aluno na escola |
| data.student.name | string | Nome do aluno |
| data.student.email | string | Nome do aluno |
| data.lesson.id | string | Id da aula |
| data.lesson.name | string | Nome da aula |
| data.module.id | string | Id do módulo |
| data.module.name | string | Nome do módulo |
| data.course.id | string | Id do curso |
| data.course.name | string | Nome do curso |
| data.team.id | string | Id da escola |
| data.team.name | string | Nome da escola |

Loading