Certificate Issued

This webhook sends an event whenever a new certificate is issued. This event is triggered when a user completes a course and requests access to the certificate by clicking the “View Certificate” button.

Event Details

Parameter	Type	Description
name	string	Name of the event: “Atividades - Certificado emitido”
slug	string	Unique identifier: activities.certificate.issued
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.
cpf	string	user’s CPF.
nickname	string | null	User’s nickname.
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.
workload	string	Course workload (e.g., “10h”).
enrolled_at	string	Enrollment date (format: “yyyy-MM-dd HH:mm:ss”).
concluded_at	string	Conclusion date (format: “yyyy-MM-dd HH:mm:ss”).

School Object

Parameter	Type	Description
id	number	Numerical identifier of the school.
name	string	Name of the school where the course was completed.
managers	array	List of school managers.
managers[].manager_id	number	Identifier of the manager.
managers[].manager_name	string	Name of the manager.

Certificate Object

Parameter	Type	Description
certified_at	string	Issuance date and time (format: “yyyy-MM-dd HH:mm:ss”).
type	string	Type of certificate (participation or achievement).
approval_rate	number	Approval rate required for achievement certificates.

---

Trigger Action

This event is triggered when a user completes a course and requests access to the certificate by clicking the “View Certificate” button.

Payload Example

{
  "event": {
    "name": "Atividades - Certificado emitido",
    "slug": "activities.certificate.issued",
    "send_at": "2023-08-28 20:47:31"
  },
  "data": {
    "institution": {
      "id": 98765432
    },
    "user": {
      "id": 12345678,
      "name": "User Name",
      "email": "user@example.com",
      "cpf": "XXX.XXX.XXX-XX",
      "nickname": null,
      "uuid": null
    },
    "course": {
      "id": 87654321,
      "name": "Course Name",
      "workload": "0h",
      "enrolled_at": "2023-08-28 20:46:18",
      "concluded_at": "2023-08-28 20:47:20"
    },
    "school": {
      "id": 1,
      "name": "Unit 1",
      "managers": [
      {
        "manager_id": 98712326,
        "manager_name": "Manager Name"
      }
    ]
    },
    "certified": {
      "certified_at": "2023-08-28 20:47:31",
      "type": "Achievement",
      "approval_rate": 25
    }
  }
}

---

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.