Trail Completed

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

Event Details

Parameter	Type	Description
`name`	string	Name of the event: “Atividades - Trilha concluída”
`slug`	string	Unique identifier: `activities.trail.completed`
`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.

Trail Object

Parameter	Type	Description
`id`	number	Numerical identifier of the trail.
`name`	string	Name of the trail.
`finished_at`	string	Date and time when the trail was completed (format: “yyyy-MM-dd HH:mm:ss”).
`courses`	array	List of objects containing information about the courses in the trail.
`courses[].id`	number	Numerical identifier of the course.
`courses[].title`	string	Title of the course.

Trigger Action

The event will be triggered when a user completes all activities of a specific learning trail.

Payload Example

{
  "event": {
    "name": "Atividades - Trilha concluída",
    "slug": "activities.trail.completed",
    "send_at": "2022-03-10 18:56:47"
  },
  "data": {
    "institution": {
      "id": 12345
    },
    "user": {
      "id": 123456798,
      "name": "Student",
      "email": "student@toolzz.com"
    },
    "trail": {
      "id": 987654,
      "name": "Trail Name",
      "finished_at": "2022-03-10 18:56:47",
      "courses": [
         {
             "id": 123456,
             "title": "Course Name"
         }
      ]
    }
  }
}

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.