Basic Service User Profile Events 0.1.0 documentation

• Protobuf File Spec: basic.proto

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

Name	Type	Description
userId	string	user id
firstName	string	first name
lastName	string	last name
avatarUrlSmall	string	avatar small url
avatarUrl	string	avatar url
avatarUrlLarge	string	avatar large url
language	string	language
timeZone	string	time zone
dateOfBirth	string (date)	date of birth
status	boolean	status
zipCode	string	zip 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

Name	Type	Description
userId	string	user id
firstName	string	first name
lastName	string	last name
avatarUrlSmall	string	avatar small url
avatarUrl	string	avatar url
avatarUrlLarge	string	avatar large url
language	string	language
timeZone	string	time zone
dateOfBirth	string (date)	date of birth
status	boolean	status
zipCode	string	zip 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

Name	Type	Description
userId	string	user id
firstName	string	first name
lastName	string	last name
avatarUrlSmall	string	avatar small url
avatarUrl	string	avatar url
avatarUrlLarge	string	avatar large url
language	string	language
timeZone	string	time zone
dateOfBirth	string (date)	date of birth
status	boolean	status
zipCode	string	zip 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

Name	Type	Description
userId	string	user id
firstName	string	first name
lastName	string	last name
avatarUrlSmall	string	avatar small url
avatarUrl	string	avatar url
avatarUrlLarge	string	avatar large url
language	string	language
timeZone	string	time zone
dateOfBirth	string (date)	date of birth
status	boolean	status
zipCode	string	zip 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

Name	Type	Description
userId	string	user id
firstName	string	first name
lastName	string	last name
avatarUrlSmall	string	avatar small url
avatarUrl	string	avatar url
avatarUrlLarge	string	avatar large url
language	string	language
timeZone	string	time zone
dateOfBirth	string (date)	date of birth
status	boolean	status
zipCode	string	zip code

Schemas

event

Name	Type	Description
id	string	-
version	integer	-
name	string	-
namespace	string	-
parentNamespace	string	-
timestamp	string (date-time)	-
clientId	string	-
userId	string	-
traceId	string	-
sessionId	string	-

userProfile

Name	Type	Description
userId	string	user id
firstName	string	first name
lastName	string	last name
avatarUrlSmall	string	avatar small url
avatarUrl	string	avatar url
avatarUrlLarge	string	avatar large url
language	string	language
timeZone	string	time zone
dateOfBirth	string (date)	date of birth
status	boolean	status
zipCode	string	zip code