Course Completed
The main purpose of this webhook is to provide updated information about course completions, allowing the institution to track the flow of graduates, manage resources, and take appropriate actions.
Event Details
Section titled “Event Details”| Parameter | Type | Description |
|---|---|---|
name | string | Name of the event: “Atividades - Curso concluído” |
slug | string | Unique identifier: activities.course.completed |
send_at | string | Date and time of the event (format: “yyyy-MM-dd HH:mm:ss”) |
Payload Structure
Section titled “Payload Structure”Institution Object
Section titled “Institution Object”| Parameter | Type | Description |
|---|---|---|
id | number | Numerical identifier of the institution. |
Course Object
Section titled “Course Object”| Parameter | Type | Description |
|---|---|---|
id | number | Numerical identifier of the course. |
name | string | Name of the course. |
Enrollment Object
Section titled “Enrollment Object”| Parameter | Type | Description |
|---|---|---|
id | number | Numerical identifier of the enrollment. |
date_expire | string | null | Expiration date of the enrollment (format: “yyyy-MM-dd”). |
course_id | number | Numerical identifier of the course associated with the enrollment. |
actived | boolean | Indicates if the enrollment is activated (1 for yes, 0 for no). |
status | number | Indicates the enrollment status (1 for active, 0 for inactive). |
User Object
Section titled “User Object”| Parameter | Type | Description |
|---|---|---|
id | number | Numerical identifier of the user. |
name | string | Name of the user. |
email | string | Email address of the user. |
cpf | string | User’s CPF. |
nickname | string | null | User’s nickname. |
uuid | string | null | Universal unique identifier of the user. |
Trigger Action
Section titled “Trigger Action”This event is triggered when a user completes a course.
Payload Example
Section titled “Payload Example”{ "event": { "name": "Atividades - Curso concluído", "slug": "activities.course.completed", "send_at": "2023-07-03 12:53:41" }, "data": { "institution": { "id": 12345 }, "course": { "id": 123456, "name": "Course Name" }, "enrollment": { "id": 11, "date_expire": null, "course_id": 123456789, "actived": 1, "status": 1 }, "user": { "id": 987654321, "name": "Student", "email": "student@toolzz.com", "cpf": "123.456.789-99", "nickname": null, "uuid": null } }}Security
Section titled “Security”Ensure that the destination URL is correct before you start sending payloads. Verify that the parameters sent are correct and complete. Make sure that the webhook recipients are correct and valid. Log and monitor all webhook calls for auditing and troubleshooting purposes.