User/Created
Triggered when a new user is created in the system.Payload
object
required
New user information
User/Edited
Triggered when user information is updated.Payload
object
required
Updated user information (same structure as User/Created)
{
"occuredAt": 1673531200,
"type": "User/Created",
"body": {
"user": {
"id": "user123",
"name": "John Smith",
"language": "en",
"occupation": "Sales Manager",
"location": "London",
"timezone": "Europe/London",
"email": "john@example.com",
"isBanned": false,
"role": {
"alias": "learner"
},
"fromApi": true,
"image": null,
"userAttributes": [
{
"apiId": "department",
"name": "Department",
"type": 1,
"value": "Sales"
}
]
}
}
}
{
"occuredAt": 1673531300,
"type": "User/Edited",
"body": {
"user": {
"id": "user123",
"name": "John Smith",
"language": "en",
"occupation": "Senior Sales Manager",
"location": "Manchester",
"timezone": "Europe/London",
"email": "john@example.com",
"isBanned": false,
"role": {
"alias": "learner"
},
"fromApi": true,
"image": null,
"userAttributes": [
{
"apiId": "department",
"name": "Department",
"type": 1,
"value": "Sales"
}
]
}
}
}
Webhooks
User Webhook Events
User-related webhook events and payloads
{
"occuredAt": 1673531200,
"type": "User/Created",
"body": {
"user": {
"id": "user123",
"name": "John Smith",
"language": "en",
"occupation": "Sales Manager",
"location": "London",
"timezone": "Europe/London",
"email": "john@example.com",
"isBanned": false,
"role": {
"alias": "learner"
},
"fromApi": true,
"image": null,
"userAttributes": [
{
"apiId": "department",
"name": "Department",
"type": 1,
"value": "Sales"
}
]
}
}
}
{
"occuredAt": 1673531300,
"type": "User/Edited",
"body": {
"user": {
"id": "user123",
"name": "John Smith",
"language": "en",
"occupation": "Senior Sales Manager",
"location": "Manchester",
"timezone": "Europe/London",
"email": "john@example.com",
"isBanned": false,
"role": {
"alias": "learner"
},
"fromApi": true,
"image": null,
"userAttributes": [
{
"apiId": "department",
"name": "Department",
"type": 1,
"value": "Sales"
}
]
}
}
}
User webhooks provide real-time notifications about user-related activities and changes.
Was this page helpful?