メインコンテンツまでスキップ
Last updated on October 14, 2025

Basic Service User Profile Events 0.1.0 documentation

Published Messages (userProfile)​

The service publishes one of these messages below.

userProfileCreated​

Message is sent when user profile is created. Contains fields from event and the following payload.

Example value
{
"payload": {
"userId": "string",
"firstName": "string",
"lastName": "string",
"avatarUrlSmall": "string",
"avatarUrl": "string",
"avatarUrlLarge": "string",
"language": "string",
"timeZone": "string",
"dateOfBirth": "2019-08-24",
"status": true,
"zipCode": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload​

NameTypeDescription
userIdstringuser id
firstNamestringfirst name
lastNamestringlast name
avatarUrlSmallstringavatar small url
avatarUrlstringavatar url
avatarUrlLargestringavatar large url
languagestringlanguage
timeZonestringtime zone
dateOfBirthstring (date)date of birth
statusbooleanstatus
zipCodestringzip code

userProfileDeleted​

Message is sent when user profile is deleted. Contains fields from event and the following payload.

Example value
{
"payload": {
"userId": "string",
"firstName": "string",
"lastName": "string",
"avatarUrlSmall": "string",
"avatarUrl": "string",
"avatarUrlLarge": "string",
"language": "string",
"timeZone": "string",
"dateOfBirth": "2019-08-24",
"status": true,
"zipCode": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload​

NameTypeDescription
userIdstringuser id
firstNamestringfirst name
lastNamestringlast name
avatarUrlSmallstringavatar small url
avatarUrlstringavatar url
avatarUrlLargestringavatar large url
languagestringlanguage
timeZonestringtime zone
dateOfBirthstring (date)date of birth
statusbooleanstatus
zipCodestringzip code

userProfileEnabled​

Message is sent when user profile is enabled. Contains fields from event and the following payload.

Example value
{
"payload": {
"userId": "string",
"firstName": "string",
"lastName": "string",
"avatarUrlSmall": "string",
"avatarUrl": "string",
"avatarUrlLarge": "string",
"language": "string",
"timeZone": "string",
"dateOfBirth": "2019-08-24",
"status": true,
"zipCode": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload​

NameTypeDescription
userIdstringuser id
firstNamestringfirst name
lastNamestringlast name
avatarUrlSmallstringavatar small url
avatarUrlstringavatar url
avatarUrlLargestringavatar large url
languagestringlanguage
timeZonestringtime zone
dateOfBirthstring (date)date of birth
statusbooleanstatus
zipCodestringzip code

userProfileDisabled​

Message is sent when user profile is disabled. Contains fields from event and the following payload.

Example value
{
"payload": {
"userId": "string",
"firstName": "string",
"lastName": "string",
"avatarUrlSmall": "string",
"avatarUrl": "string",
"avatarUrlLarge": "string",
"language": "string",
"timeZone": "string",
"dateOfBirth": "2019-08-24",
"status": true,
"zipCode": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload​

NameTypeDescription
userIdstringuser id
firstNamestringfirst name
lastNamestringlast name
avatarUrlSmallstringavatar small url
avatarUrlstringavatar url
avatarUrlLargestringavatar large url
languagestringlanguage
timeZonestringtime zone
dateOfBirthstring (date)date of birth
statusbooleanstatus
zipCodestringzip code

userProfileUpdated​

Message is sent when user profile is updated. Contains fields from event and the following payload.

Example value
{
"payload": {
"userId": "string",
"firstName": "string",
"lastName": "string",
"avatarUrlSmall": "string",
"avatarUrl": "string",
"avatarUrlLarge": "string",
"language": "string",
"timeZone": "string",
"dateOfBirth": "2019-08-24",
"status": true,
"zipCode": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload​

NameTypeDescription
userIdstringuser id
firstNamestringfirst name
lastNamestringlast name
avatarUrlSmallstringavatar small url
avatarUrlstringavatar url
avatarUrlLargestringavatar large url
languagestringlanguage
timeZonestringtime zone
dateOfBirthstring (date)date of birth
statusbooleanstatus
zipCodestringzip code

Schemas​

event​

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
clientIdstring-
userIdstring-
traceIdstring-
sessionIdstring-

userProfile​

NameTypeDescription
userIdstringuser id
firstNamestringfirst name
lastNamestringlast name
avatarUrlSmallstringavatar small url
avatarUrlstringavatar url
avatarUrlLargestringavatar large url
languagestringlanguage
timeZonestringtime zone
dateOfBirthstring (date)date of birth
statusbooleanstatus
zipCodestringzip code