Activity Answered

This webhook provides real-time information about user progress and activity answers, regardless of the activity result. This allows the institution to track user engagement, analyze performance, and take appropriate actions.

Event Details

Parameter	Type	Description
`name`	string	Name of the event: “Atividades - Atividade respondida”
`slug`	string	Unique identifier: `activities.answered.activity`
`send_at`	string	Date and time of the event (format: “yyyy-MM-dd HH:mm:ss”)

Payload Structure

Institution Object

Parameter	Type	Description
`id`	number	Numerical identifier of the institution.

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.
`uuid`	string \| null	Universal unique identifier of the user.

Course Object

Parameter	Type	Description
`id`	number	Numerical identifier of the course.
`name`	string	Name of the course.

Content Object

Parameter	Type	Description
`id`	number	Numerical identifier of the content.
`type`	number	Number representing the content type.
`answer`	string	URL or path to the activity response.
`correct`	boolean \| null	Indicates if the answer is correct.
`explanation`	string \| null	Explanation associated with the answer.
`points`	number \| null	Number of points associated with the content.
`date_delivery`	string \| null	Delivery date of the activity (format: “yyyy-MM-dd”).
`content_delivery`	number	Represents the type of content delivery.
`current_time`	string \| null	Current time associated with the content (format: “HH:mm:ss”).

Trigger Action

The event will be triggered whenever an activity answer is submitted, allowing the institution or system to receive real-time notifications about completed activities by users.

Payload Example

 {
  "event": {
    "name": "Atividades - Atividade respondida",
    "slug": "activities.answered.activity",
    "send_at": "2023-07-03 12:54:33"
  },
  "data": {
    "institution": {
      "id": 12345
    },
    "user": {
      "id": 123456789,
      "name": "Student",
      "email": "student@toolzz.com",
      "uuid": null
    },
    "course": {
      "id": 123,
      "name": "Activity Name"
    },
    "content": {
      "id": 35502788,
      "type": 10,
      "answer": "link_to_file_sent_by_student",
      "correct": null,
      "explanation": null,
      "points": null,
      "date_delivery": null,
      "content_delivery": 0,
      "current_time": null
    }
  }
}

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.