Content Completed

The main purpose of this webhook is to provide a real-time notification when a user completes a content. This allows the institution or system to record and track user progress.

Event Details

Parameter	Type	Description
`name`	string	Name of the event: “Atividades - Conteúdo”
`slug`	string	Unique identifier: `activities.content.completed`
`send_at`	string	Date and time of the event (format: “yyyy-MM-dd HH:mm:ss”)

Payload Structure

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.

Content Object

Parameter	Type	Description
`id`	number	Numerical identifier of the record in the `conteudo_completo` table.
`institution_id`	number	Numerical identifier of the institution related to the content.
`school_id`	number	Numerical identifier of the school related to the content.
`course_id`	number	Numerical identifier of the course related to the content.
`lesson_id`	number	Numerical identifier of the lesson related to the content.
`content_id`	number \| null	Numerical identifier of the specific content.
`answer`	string \| null	Answer provided by the user.
`correct`	boolean \| null	Indicates if the answer is correct.
`explanation`	string \| null	Explanation associated with the content.
`points`	number \| null	Score assigned to the content.
`send_date`	string \| null	Date and time when the content was sent.
`delivered`	boolean	Indicates if the content was delivered (0 for no, 1 for yes).
`current_time`	string \| null	Current time at the moment of the event.

Course Object

Parameter	Type	Description
`id`	number	Numerical identifier of the course.
`name`	string	Name of the course.
`certificate_id`	number \| null	Identifier of the certificate associated with the course.
`progress`	number	Completion percentage.

Trigger Action

The event will be triggered when the user completes any content.

Payload Example

{
  "event": {
    "name": "Atividades - Conteúdo",
    "slug": "activities.content.completed",
    "send_at": "2022-03-10 12:01:43"
  },
  "data": {
    "user": {
      "id": 1234,
      "name": "Student",
      "email": "student@toolzz.me"
    },
    "content": {
      "id": 4,
      "institution_id": 123,
      "school_id": 654,
      "course_id": 666,
      "lesson_id": 4,
      "content_id": null,
      "answer": null,
      "correct": null,
      "explanation": null,
      "points": null,
      "send_date": null,
      "delivered": 0,
      "current_time": null
    },
    "course": {
      "id": 666,
      "name": "Course Name",
      "certificate_id": null,
      "progress": 33
    }
  }
}

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.