This section provides the list of events and associated payloads for the Customers (User) microservice.
List of Events
| SL.# | NAME | DESCRIPTION | PUBLISH LOCATION | ROUTING KEY | DURABILITY | PAYLOAD TYPE |
|---|---|---|---|---|---|---|
| 1 | User Created | This event is created when a user is created successfully. It has complete information about the user. | Topic: ecomm | user.usercreated | true | UserCreated |
| 2 | Reset Password | This event is created when a user is trying to reset the password. It has the user information like email ID and phone number. | Topic: ecomm | user.resetpassword | true | ResetPassword |
| 3 | Validate Activation | This event is created when a user is activated successfully. It has the user information like user ID. | Topic: ecomm | user.activationsuccess | true | ValidateActivation |
| 4 | Validate Reset Password | This event is created when a user resets the password successfully. It has the user information like user ID. | Topic: ecomm | user.resetsuccess | true | ValidateResetPassword |
| 5 | Delete User | This event is created when a user account is deleted successfully. It has the user information like user ID, email ID, phone number, first name, and last name. | Topic: ecomm | user.userdeleted | true | DeleteUser |
| 6 | Update User | This event is created when a user account is updated successfully. It has the user information like user ID, email ID, phone number, first name, and last name. | Topic: ecomm | user.userupdated | true | UpdateUser |
| 7 | Resend Activation | This event is created when a user is invited again successfully. It has the user information like user ID, email ID, phone number, first name, and last name. | Topic: ecomm | user.resendactivation | true | ResendActivation |
| 8 | Send Notification | This event is created when a user sends a notification successfully. It has the user information like user ID, email ID, phone number, first name, and last name. | Topic: ecomm | user.sendnotification | true | SendNotification |
| 9 | Validate Notification | This event is created when a user validates the notification param successfully. It has the user information like user ID, email ID, phone number, first name, and last name. | Topic: ecomm | user.notificationsuccess | true | ValidateNotification |
| 10 | User MFA Login | This event is created when a user sends an MFA login OTP successfully. It has the user information like user ID, email ID, phone number, first name, last name, login OTP, and login token. | Topic: ecomm | user.userloginMFA | true | UserMFALogin |
| 11 | User Merge | This event is created when a user is merged successfully with the token user. It has the user information like fakeUserId and winnerUserId. | Topic: ecomm | user.usermerged | true | UserMerge |
Payload Models
Below are the payloads for the Customers (User) microservice.
UserCreated
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the unique ID of the collection. | 1 |
storeId | long | Indicates the unique ID of the store. | 1 |
users.id | long | Indicates the ID of the user. | 1 |
users.email | string | Indicates the unique email address of the user. | test@skava.com |
users.phoneNumber | string | Holds the unique phone number of the user. | 9999999999 |
users.firstName | string | Indicates the first name of the user. | John |
users.lastName | string | Indicates the last name of the user. | Smith |
users.status | string | Indicates the status of the user. | NOTACTIVATED |
users.type | string | Indicates the user type, such as a guest user or a registered user. | 1 |
users.gender | string | Indicates the gender of the user. | male |
users.photo | string | Holds the uploaded image URL of the user's profile photo. | string_url |
users.dateOfBirth | string | Indicates the user's date of birth. | 08-10-1990 |
users.resetParam | string | Indicates the reset parameter, which is received through the email or SMS. | |
users.notificationParam | string | Indicates the notification parameter, which is received through the email or SMS. | |
users.activationParam | string | Indicates the activation param, which is used to activate the user. | a72240a24692b78103c866f8c268110f48fc7e583dcd77d01beee64ad01b1b50 |
users.preferences | string | Indicates the user's preferences, which are either email or phone number. | |
users.createdDate | Date | Indicates the created timestamp of the user. | 1543558673000 |
users.updatedDate | Date | Indicates the updated timestamp of the user. | 1543558673000 |
users.addressess | list | Indicates the address of the user. | |
users.userConsents | list | Refers to the list of user consents details. | |
resetPasswordRedirectUrl | string | Indicates the redirect URL of the site, which is used to reset the user password. | |
activationRedirectUrl | string | Indicates the redirect URL of the site, which is used to activate the user. | https://uxui.skavaone.com/ |
activationParamExpiryMillisec | string | Refers to the expiry time (in millisecond) of the user's activation parameter. | 86400000 |
resetParamExpiryMillisec | long | Refers to the expiry time (in millisecond) of the user's reset parameter. | 86400000 |
inviteUserFlag | boolean | Indicates whether an invite email or a welcome email needs to be sent or not. | true |
ResetPassword
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the unique ID of the collection. | 1 |
storeId | long | Indicates the unique ID of the store. | 1 |
users.id | long | Indicates the ID of the user. | 1 |
users.email | string | Indicates the unique email address of the user. | test@skava.com |
users.phoneNumber | string | Holds the unique phone number of the user. | 9999999999 |
users.firstName | string | Indicates the first name of the user. | John |
users.lastName | string | Indicates the last name of the user. | Smith |
users.status | string | Indicates the status of a user. | |
users.type | string | Indicates the user type, such as a guest user or a registered user. | |
users.gender | string | Refers to the gender of the user. | |
users.photo | string | Holds the uploaded image URL of the user's profile photo. | |
users.dateOfBirth | string | Indicates the user's date of birth. | |
users.resetParam | string | Indicates the reset parameter, which is received through the email or SMS. | e6b2c0468120e9034067f4c70bf6f179fa1b11634cc69ba89d991ccf783058d6 |
users.notificationParam | string | Indicates the notification parameter, which is received through the email or SMS. | |
users.activationParam | string | Indicates the activation param, which is used to activate the user. | |
users.preferences | string | Indicates the user's preferences, which are either email or phone number. | |
users.createdDate | Date | Indicates the created timestamp of the user. | |
users.updatedDate | Date | Indicates the updated timestamp of the user. | |
users.addressess | list | Indicates the user's address. | |
users.userConsents | list | Refers to the list of user consents details. | |
resetPasswordRedirectUrl | string | Indicates the redirect URL of the site, which is used to reset the user password. | https://uxui.skavaone.com/ |
activationRedirectUrl | string | Indicates the redirect URL of the site, which is used to activate the user. | |
activationParamExpiryMillisec | string | Refers to the expiry time (in millisecond) of the user's activation parameter. | 86400000 |
resetParamExpiryMillisec | long | Refers to the expiry time (in millisecond) of the user's reset parameter. | 86400000 |
inviteUserFlag | boolean | Indicates whether an invite email or a welcome email needs to be sent or not. | true |
ValidateActivation
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the unique ID of the collection. | 1 |
storeId | long | Indicates the unique ID of the store. | 1 |
users.id | long | Indicates the ID of the user. | 1 |
users.email | string | Indicates the unique email address of the user. | |
users.phoneNumber | String | Holds the unique phone number of the user. | |
users.firstName | string | Indicates the first name of the user. | |
users.lastName | string | Indicates the last name of the user. | |
users.status | string | Indicates the status of a user. | |
users.type | string | Indicates the user type, such as a guest user or a registered user. | |
users.gender | string | Refers to the gender of the user. | |
users.photo | string | Holds the uploaded image URL of the user's profile photo. | |
users.dateOfBirth | string | Indicates the user's date of birth. | |
users.resetParam | string | Indicates the reset parameter, which is received through the email or SMS. | e6b2c0468120e9034067f4c70bf6f179fa1b11634cc69ba89d991ccf783058d6 |
users.notificationParam | string | Indicates the notification parameter, which is received through the email or SMS. | |
users.activationParam | string | Indicates the activation param, which is used to activate the user. | |
users.preferences | string | Indicates the user's preferences, which are either email or phone number. | |
users.createdDate | Date | Indicates the created timestamp of the user. | |
users.updatedDate | Date | Indicates the updated timestamp of the user. | |
users.addressess | list | Indicates the address of the user. | |
users.userConsents | list | Refers to the list of user consents details. | |
resetPasswordRedirectUrl | string | Indicates the redirect URL of the site, which is used to reset the user password. | |
activationRedirectUrl | string | Indicates the redirect URL of the site, which is used to activate the user. | |
activationParamExpiryMillisec | string | Refers to the expiry time (in millisecond) of the user's activation parameter. | |
resetParamExpiryMillisec | long | Refers to the expiry time (in millisecond) of the user's reset parameter. | |
inviteUserFlag | boolean | Indicates whether an invite email or a welcome email needs to be sent or not. | false |
ValidateResetPassword
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the unique ID of the collection. | 1 |
storeId | long | Indicates the unique ID of the store. | 1 |
users.id | long | Indicates the ID of the user. | 1 |
users.email | string | Indicates the unique email address of the user. | |
users.phoneNumber | String | Holds the unique phone number of the user. | |
users.firstName | string | Indicates the first name of the user. | |
users.lastName | string | Indicates the last name of the user. | |
users.status | string | Indicates the status of a user. | |
users.type | string | Indicates the user type, such as a guest user or a registered user. | |
users.gender | string | Refers to the gender of the user. | |
users.photo | string | Holds the uploaded image URL of the user's profile photo. | |
users.dateOfBirth | string | Indicates the user's date of birth. | |
users.resetParam | string | Indicates the reset parameter, which is received through the email or SMS. | e6b2c0468120e9034067f4c70bf6f179fa1b11634cc69ba89d991ccf783058d6 |
users.notificationParam | string | Indicates the notification parameter, which is received through the email or SMS. | |
users.activationParam | string | Indicates the activation param, which is used to activate the user. | |
users.preferences | string | Indicates the user's preferences, which are either email or phone number. | |
users.createdDate | Date | Indicates the created timestamp of the user. | |
users.updatedDate | Date | Indicates the updated timestamp of the user. | |
users.addressess | list | Indicates the address of the user. | |
users.userConsents | list | Refers to the list of user consents details. | |
resetPasswordRedirectUrl | string | Refers to the redirect URL of the site used which is used to reset the user password. | |
activationRedirectUrl | string | Refers to the redirect URL of the site, which is used to activate the user. | |
activationParamExpiryMillisec | string | Refers to the expiry time (in millisecond) of the user's activation parameter. | |
resetParamExpiryMillisec | long | Refers to the expiry time (in millisecond) of the user's reset parameter. | |
inviteUserFlag | boolean | Indicates whether an invite email or a welcome email needs to be sent or not. | false |
DeleteUser
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the unique ID of the collection. | 1 |
storeId | long | Indicates the unique ID of the store. | 1 |
users.id | long | Indicates the ID of the user. | 1 |
users.email | string | Indicates the unique email address of the user. | test@skava.com |
users.phoneNumber | String | Holds the unique phone number of the user. | 9999999999 |
users.firstName | string | Indicates the first name of the user. | John |
users.lastName | string | Indicates the last name of the user. | Smith |
users.status | string | Indicates the status of the user. | |
users.type | string | Indicates the user type, such as a guest user or a registered user. | |
users.gender | string | Indicates the gender of the user. | |
users.photo | string | Holds the uploaded image URL of the user's profile photo. | |
users.dateOfBirth | string | Indicates the user's date of birth. | |
users.resetParam | string | Indicates the reset parameter, which is received through the email or SMS. | |
users.notificationParam | string | Indicates the notification parameter, which is received through the email or SMS. | |
users.activationParam | string | Indicates the activation param, which is used to activate the user. | |
users.preferences | string | Indicates the user's preferences, which are either email or phone number. | |
users.createdDate | Date | Indicates the created timestamp of the user. | |
users.updatedDate | Date | Indicates the updated timestamp of the user. | |
users.addressess | list | Indicates the address of the user. | |
users.userConsents | list | Refers to the list of user consents details. | |
resetPasswordRedirectUrl | string | Indicates the redirect URL of the site, which is used to reset the user password. | |
activationRedirectUrl | string | Indicates the redirect URL of the site, which is used to activate the user. | |
activationParamExpiryMillisec | string | Refers to the expiry time (in millisecond) of the user's activation parameter. | |
resetParamExpiryMillisec | long | Refers to the expiry time (in millisecond) of the user's reset parameter. | |
inviteUserFlag | boolean | Indicates whether an invite email or a welcome email needs to be sent or not. | false |
UpdateUser
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the unique ID of the collection. | 1 |
storeId | long | Indicates the unique ID of the store. | 1 |
users.id | long | Indicates the ID of the user. | 1 |
users.email | string | Indicates the unique email address of the user. | test@skava.com |
users.phoneNumber | String | Holds the unique phone number of the user. | 9999999999 |
users.firstName | string | Indicates the first name of the user. | John |
users.lastName | string | Indicates the last name of the user. | Smith |
users.status | string | Indicates the status of the user. | |
users.type | string | Indicates the user type, such as a guest user or a registered user. | |
users.gender | string | Indicates the gender of the user. | |
users.photo | string | Holds the uploaded image URL of the user's profile photo. | |
users.dateOfBirth | string | Indicates the user's date of birth. | |
users.resetParam | string | Indicates the reset parameter, which is received through the email or SMS. | |
users.notificationParam | string | Indicates the notification parameter, which is received through the email or SMS. | |
users.activationParam | string | Indicates the activation param, which is used to activate the user. | |
users.preferences | string | Indicates the user's preferences, which are either email or phone number. | |
users.createdDate | Date | Indicates the created timestamp of the user. | |
users.updatedDate | Date | Indicates the updated timestamp of the user. | |
users.addressess | list | Indicates the address of the user. | |
users.userConsents | list | Refers to the list of user consents details. | |
resetPasswordRedirectUrl | string | Indicates the redirect URL of the site, which is used to reset the user password. | |
activationRedirectUrl | string | Indicates the redirect URL of the site, which is used to activate the user. | |
activationParamExpiryMillisec | string | Refers to the expiry time (in millisecond) of the user's activation parameter. | |
resetParamExpiryMillisec | long | Refers to the expiry time (in millisecond) of the user's reset parameter. | |
inviteUserFlag | boolean | Indicates whether an invite email or a welcome email needs to be sent or not. | false |
ResendActivation
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the unique ID of the collection. | 1 |
storeId | long | Indicates the unique ID of the store. | 1 |
users.id | long | Indicates the ID of the user. | 1 |
users.email | string | Indicates the unique email address of the user. | test@skava.com |
users.phoneNumber | String | Holds the unique phone number of the user. | 9999999999 |
users.firstName | string | Indicates the first name of the user. | John |
users.lastName | string | Indicates the last name of the user. | Smith |
users.status | string | Indicates the status of the user. | |
users.type | string | Indicates the user type, such as a guest user or a registered user. | |
users.gender | string | Indicates the gender of the user. | |
users.photo | string | Holds the uploaded image URL of the user's profile photo. | |
users.dateOfBirth | string | Indicates the user's date of birth. | |
users.resetParam | string | Indicates the reset parameter, which is received through the email or SMS. | |
users.notificationParam | string | Indicates the notification parameter, which is received through the email or SMS. | |
users.activationParam | string | Indicates the activation param, which is used to activate the user. | |
users.preferences | string | Indicates the user's preferences, which are either email or phone number. | |
users.createdDate | Date | Indicates the created timestamp of the user. | |
users.updatedDate | Date | Indicates the updated timestamp of the user. | |
users.addressess | list | Indicates the address of the user. | |
users.userConsents | list | Refers to the list of user consents details. | |
resetPasswordRedirectUrl | string | Indicates the redirect URL of the site, which is used to reset the user password. | |
activationRedirectUrl | string | Indicates the redirect URL of the site, which is used to activate the user. | |
activationParamExpiryMillisec | string | Refers to the expiry time (in millisecond) of the user's activation parameter. | |
resetParamExpiryMillisec | long | Refers to the expiry time (in millisecond) of the user's reset parameter. | |
inviteUserFlag | boolean | Indicates whether an invite email or a welcome email needs to be sent or not. | false |
SendNotification
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the unique ID of the collection. | 1 |
storeId | long | Indicates the unique ID of the store. | 1 |
users.id | long | Indicates the ID of the user. | 1 |
users.email | string | Indicates the unique email address of the user. | test@skava.com |
users.phoneNumber | String | Holds the unique phone number of the user. | 9999999999 |
users.firstName | string | Indicates the first name of the user. | John |
users.lastName | string | Indicates the last name of the user. | Smith |
users.status | string | Indicates the status of the user. | |
users.type | string | Indicates the user type, such as a guest user or a registered user. | |
users.gender | string | Indicates the gender of the user. | |
users.photo | string | Holds the uploaded image URL of the user's profile photo. | |
users.dateOfBirth | string | Indicates the user's date of birth. | |
users.resetParam | string | Indicates the reset parameter, which is received through the email or SMS. | |
users.notificationParam | string | Indicates the notification parameter, which is received through the email or SMS. | 0be6c3c5b22fd7658f30424e75132def976e1b85b85ff0433b1df44f54f84705 |
users.activationParam | string | Indicates the activation param, which is used to activate the user. | |
users.preferences | string | Indicates the user's preferences, which are either email or phone number. | |
users.createdDate | Date | Indicates the created timestamp of the user. | |
users.updatedDate | Date | Indicates the updated timestamp of the user. | |
users.addressess | list | Indicates the address of the user. | |
users.userConsents | list | Refers to the list of user consents details. | |
resetPasswordRedirectUrl | string | Indicates the redirect URL of the site, which is used to reset the user password. | |
activationRedirectUrl | string | Indicates the redirect URL of the site, which is used to activate the user. | |
activationParamExpiryMillisec | string | Refers to the expiry time (in millisecond) of the user's activation parameter. | |
resetParamExpiryMillisec | long | Refers to the expiry time (in millisecond) of the user's reset parameter. | |
inviteUserFlag | boolean | Indicates whether an invite email or a welcome email needs to be sent or not. | false |
ValidateNotification
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the unique ID of the collection. | 1 |
storeId | long | Indicates the unique ID of the store. | 1 |
users.id | long | Indicates the ID of the user. | 1 |
users.email | string | Indicates the unique email address of the user. | test@skava.com |
users.phoneNumber | String | Holds the unique phone number of the user. | 9999999999 |
users.firstName | string | Indicates the first name of the user. | John |
users.lastName | string | Indicates the last name of the user. | Smith |
users.status | string | Indicates the status of the user. | |
users.type | string | Indicates the user type, such as a guest user or a registered user. | |
users.gender | string | Indicates the gender of the user. | |
users.photo | string | Holds the uploaded image URL of the user's profile photo. | |
users.dateOfBirth | string | Indicates the user's date of birth. | |
users.resetParam | string | Indicates the reset parameter, which is received through the email or SMS. | |
users.notificationParam | string | Indicates the notification parameter, which is received through the email or SMS. | |
users.activationParam | string | Indicates the activation param, which is used to activate the user. | |
users.preferences | string | Indicates the user's preferences, which are either email or phone number. | |
users.createdDate | Date | Indicates the created timestamp of the user. | |
users.updatedDate | Date | Indicates the updated timestamp of the user. | |
users.addressess | list | Indicates the address of the user. | |
users.userConsents | list | Refers to the list of user consents details. | |
resetPasswordRedirectUrl | string | Indicates the redirect URL of the site, which is used to reset the user password. | |
activationRedirectUrl | string | Indicates the redirect URL of the site, which is used to activate the user. | |
activationParamExpiryMillisec | string | Refers to the expiry time (in millisecond) of the user's activation parameter. | |
resetParamExpiryMillisec | long | Refers to the expiry time (in millisecond) of the user's reset parameter. | |
inviteUserFlag | boolean | Indicates whether an invite email or a welcome email needs to be sent or not. | false |
UserMFALogin
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
id | long | Indicates the ID of the user. | 1 |
email | string | Indicates the unique email address of the user. | test@skava.com |
phoneNumber | String | Holds the unique phone number of the user. | 9999999999 |
firstName | string | Indicates the first name of the user. | John |
lastName | string | Indicates the last name of the user. | Smith |
loginOTP | string | Indicates the login OTP, which is used for validating the OTP of a user for 2FA (2-Factor Authentication). | 884204 |
loginToken | string | Indicates the login token, which is used for validating the OTP of a user for 2FA (2-Factor Authentication). | 6a5b011c9a0b2e2162cd136789d9808406334588b789462d36fe75ddb309c2ac |
UserMerge
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
userMerge.fakeUserId | long | Indicates the ID of the user, which will be deleted as part of the user merge. | 1 |
userMerge.winnerUserId | long | Indicates the ID of the user, which will be retained as part of the user merge. | 2 |
Revision History
2019-06-08 | PLK – Minor copyedits.
2019-05-16 | AM – Updated to a new table tool.
2019-04-11 | AM – Updated content and format for April 2019 release.
2019-01-21 | PLK – Page created and content uploaded.
