Skip to content

Status Change

The main purpose of this webhook is to provide a real-time notification when a registration is disabled or a status change occurs. This allows the institution or system to track changes in user status.

ParameterTypeDescription
namestringName of the event: “Membros - Edição de dados de usuário”
slugstringUnique identifier: members.updated
send_atstringDate and time of the event (format: “yyyy-MM-dd HH:mm:ss”)
acaostringAction associated with the event: atualização

ParameterTypeDescription
idnumberNumerical identifier of the user.
namestringName of the user.
emailstringEmail address of the user.
institutionarrayList of institutions the user belongs to.
institution[].idnumberInstitution identifier.
institution[].schoolsarraySchools associated with the institution.
institution[].schools[].idnumberSchool identifier.
institution[].schools[].role_idnumberUser role ID in the school.
institution[].schools[].created_atstringCreation date (format: “dd/MM/yyyy HH:mm:ss”).
institution[].schools[].updated_atstringLast update date (format: “dd/MM/yyyy HH:mm:ss”).
cpfstringUser’s CPF.
nicknamestring | nullUser’s nickname.
uuidstring | nullUniversal unique identifier of the user.

The event will be triggered when a user’s status is changed, for example, from “active” to “inactive”.

{
"event": {
"name": "Membros - Edição de dados de usuário",
"slug": "members.updated",
"send_at": "2023-07-03 14:29:26",
"acao": "atualização"
},
"data": {
"user": {
"id": 123456,
"name": "Student",
"email": "student@toolzz.com",
"institution": [
{
"id": 12345,
"schools": [
{
"id": 123456789,
"role_id": 4,
"created_at": "29/06/2022 15:14:10",
"updated_at": "03/07/2023 14:29:04"
}
]
}
],
"cpf": "123.456.789-99",
"nickname": null,
"uuid": null
}
}
}

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.