Skip to main content

User profile update

The user:profile_update event fires when a user's basic profile information or extended metadata is modified or cleared. Use this event to keep profile data in sync on your app server.

For the complete webhook setup and signature verification guide, see Webhooks overview.

Event type

user:profile_update

Payload

Envelope

FieldTypeRequiredDescription
typeStringYes"user:profile_update"
idStringYesUnique event ID.
timeLongYesEvent generation time (Unix ms).
dataArrayYesArray containing one profile update object. See Data fields.

Data fields

FieldTypeRequiredDescription
operatorIdStringYesThe user ID of the account whose profile was changed (or the operator who triggered the change).
operationTypeIntYesChange type. 0 = cleared. 1 = modified.
timeLongYesTime the change was made (Unix ms).
userProfileObjectNoModified basic profile information as a JSON object. Present only when operationType is 1.
userMetaDataObjectNoModified extended metadata as a JSON object. Present only when operationType is 1.

Operation types

ValueMeaning
0Cleared — The user's profile data was deleted. userProfile and userMetaData are not included.
1Modified — One or more profile fields were updated. Changed fields are included in userProfile and/or userMetaData.

Example

JSON
{
"type": "user:profile_update",
"id": "550e8400-e29b-41d4-a716-446655440003",
"time": 1730192400000,
"data": [
{
"operatorId": "user_001",
"operationType": 1,
"time": 1730192400000,
"userProfile": {"nickname": "Alice", "portraitUri": "https://example.com/avatar.png"},
"userMetaData": {"level": "5"}
}
]
}