This page provides the list of events and associated payload for internal events (via RabbitMQ/AWS MQ) and external events (via EventBridge) for the Customers (User) microservice.

External Events via EventBridge

The following events contain the entity changed in the event message payload.

List of Events

Sl. No.	API Call	Call Detail	Event Type	Identifier
1.	POST	CreateActivation	`userservice/activation/create`
2.	PATCH	UpdateActivation	`userservice/activation/patch`
3.	DELETE	DeleteAddress	`userservice/address/delete`	`request_userId`
4.	POST	CreateAddresses	`userservice/addresses/create`	`response_addresses.id`
5.	POST	CreateConsent	`userservice/consent/create`	`response_consents.id`
6.	DELETE	DeleteConsent	`userservice/consent/delete`	`request_id`
7.	PATCH	UpdateConsents	`userservice/consents/patch`
8.	POST	CreateCredential	`userservice/credential/create`
9.	DELETE	DeleteCustomProperty	`userservice/customproperty/delete`
10.	PATCH	UpdateCustomProperty	`userservice/customproperty/patch`
11.	POST	CreateNotes	`userservice/notes/create`	`response_notes.id`
12.	DELETE	DeleteNotes	`userservice/notes/delete`	`request_id`
13.	POST	CreateSecurityQuestion	`userservice/securityquestion/create`
14.	POST	GetAllSecurityQuestions	`userservice/securityquestions/get`	`response_users.id`
15.	PUT	UpdateSecurityQuestions	`userservice/securityquestions/update`	`response_users.id`
16.	POST	CreateUser	`userservice/user/create`	`response_users.id`
17.	DELETE	DeleteUser	`userservice/user/delete`	`request_users.id`
18.	PUT	UpdateUser	`userservice/user/update`	`response_users.id`
19.	DELETE	DeleteUserConsent	`userservice/userconsent/delete`	`request_id`
20.	POST	CreateUserNotification	`userservice/usernotification/create`
21.	PATCH	UpdateUserPassword	`userservice/userpassword/patch`	`response_users.id`

Payload

CreateActivation

Event Type: userservice/activation/create


{
  "version": "0",
  "id": "1af79caa-d534-fd3f-924e-a39e361fcb14",
  "detail-type": "userservice/activation/create",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:58:15Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357495978,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success",
      "users": [
        {
          "guest": false,
          "id": 12085,
          "collectionId": 0,
          "type": 0,
          "referenceAttribute2": 0,
          "customProperties": {
            "lastactivationparam": "27d0891080f5d2f3dc1fda282fa9fa48a7ad4f2a66d4a76aa548961e4cce3f35"
          },
          "availableResend": 0,
          "maximumOTPAttempt": 0
        }
      ]
    },
    "collectionId": "692",
    "eventType": "userservice/activation/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN",
      "ROLE_REG_USER",
      "ROLE_GUEST"
    ],
    "channel": "SF_USER"
  }
}

UpdateActivation

Event Type: userservice/activation/patch

{
  "version": "0",
  "id": "4f7ab129-0689-4b8f-d187-3816ccff2ba7",
  "detail-type": "userservice/activation/patch",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:58:29Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "12086",
    "timestamp": 1716357509973,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success",
      "users": {
        "guest": false,
        "id": 12086,
        "collectionId": 0,
        "type": 0,
        "referenceAttribute2": 0,
        "customProperties": {
          "bearerToken": "6c8988628de001f034f17ba0f136675131e12507ea81186b3201772fed8590fb"
        },
        "availableResend": 0,
        "maximumOTPAttempt": 0
      }
    },
    "collectionId": "693",
    "eventType": "userservice/activation/patch",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN",
      "ROLE_REG_USER",
      "ROLE_GUEST"
    ],
    "channel": "SF_USER"
  }
}

DeleteAddress

Event Type: userservice/address/delete


{
  "version": "0",
  "id": "d75b389e-dd6e-67bd-e3af-48488cdfa4e0",
  "detail-type": "userservice/address/delete",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:58:38Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "12087",
    "timestamp": 1716357518322,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success",
      "addresses": [
        
      ]
    },
    "collectionId": "694",
    "eventType": "userservice/address/delete",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN",
      "ROLE_REG_USER",
      "ROLE_GUEST"
    ],
    "channel": "SF_USER"
  }
}

CreateAddresses

Event Type: userservice/addresses/create


{
  "version": "0",
  "id": "d3a0c930-39e1-beae-fe2e-c27e81fd10a0",
  "detail-type": "userservice/addresses/create",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:56:16Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357376454,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success",
      "addresses": [
        {
          "id": 2858,
          "type": "billing",
          "firstName": "Idola",
          "middleName": "k",
          "lastName": "Bond",
          "phone": "2747053505",
          "email": "Email_1716357376406@skava.com",
          "street1": "467 Shaffer Way",
          "street2": "string",
          "street3": "string",
          "city": "Oshkosh",
          "country": "Madagascar",
          "county": "string",
          "state": "Maine",
          "zipCode": "09106",
          "validated": false,
          "createdDate": 1716357376000,
          "updatedDate": 1716357376000,
          "overridden": true,
          "validationType": "RVeQKk",
          "validatedOn": 88,
          "createdBy": 1,
          "updatedBy": 1,
          "default": true
        }
      ]
    },
    "collectionId": "686",
    "eventType": "userservice/addresses/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

CreateConsent

Event Type: userservice/consent/create


{
  "version": "0",
  "id": "a1fce545-2f81-7165-f3e2-17469540138f",
  "detail-type": "userservice/consent/create",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:56:31Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357391527,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success",
      "consents": [
        {
          "id": 226,
          "collectionId": 686,
          "title": "Consent04451Lm8NlkRqmj9X16RErigqA8b459F2hly",
          "requiredFlag": true,
          "status": "INACTIVE",
          "createdBy": 1,
          "createdTimestamp": 1716357391504,
          "updatedBy": 1,
          "updatedTimestamp": 1716357391504
        }
      ]
    },
    "collectionId": "686",
    "eventType": "userservice/consent/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

DeleteConsent

Event Type: userservice/consent/delete


{
  "version": "0",
  "id": "ce84f291-6e7f-6069-90bc-0465efbae92e",
  "detail-type": "userservice/consent/delete",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:57:08Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "226",
    "timestamp": 1716357428473,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success"
    },
    "collectionId": "686",
    "eventType": "userservice/consent/delete",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

UpdateConsents

Event Type: userservice/consents/patch


{
  "version": "0",
  "id": "3adbd5dc-1860-9500-bdb6-262569295b8b",
  "detail-type": "userservice/consents/patch",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:58:02Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357482327,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success",
      "consents": [
        {
          "id": 227,
          "collectionId": 691,
          "title": "Consent072912F",
          "requiredFlag": true,
          "status": "INACTIVE",
          "createdBy": 1,
          "createdTimestamp": 1716357482000,
          "updatedBy": 1,
          "updatedTimestamp": 1716357482326
        }
      ]
    },
    "collectionId": "691",
    "eventType": "userservice/consents/patch",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN",
      "ROLE_REG_USER",
      "ROLE_GUEST"
    ],
    "channel": "SF_USER"
  }
}

CreateCredential

Event Type: userservice/credential/create


{
  "version": "0",
  "id": "778dcc92-8c38-8c76-64df-ea5e56b34d7a",
  "detail-type": "userservice/credential/create",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:59:26Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "0",
    "timestamp": 1716357566470,
    "payload": {
      "resetParam": "5dc9dbfa3443060d8fd7c92bb1188dd9dbc267ae00d8f0afc4b93da9f2397dde"
    },
    "collectionId": "697",
    "eventType": "userservice/credential/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

DeleteCustomProperty

Event Type: userservice/customproperty/delete


{
  "version": "0",
  "id": "fa0a8f29-cc5b-4bde-1e97-16587033e0e7",
  "detail-type": "userservice/customproperty/delete",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:59:12Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357552484,
    "payload": {
      "responseCode": "USER_231",
      "responseMessage": "User Custom Property deleted Successfully",
      "users": [
        
      ]
    },
    "collectionId": "695",
    "eventType": "userservice/customproperty/delete",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

UpdateCustomProperty

Event Type: userservice/customproperty/patch


{
  "version": "0",
  "id": "d0f9f0d1-bf30-8207-5754-d39a28300660",
  "detail-type": "userservice/customproperty/patch",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:58:51Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357531652,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success",
      "users": [
        {
          "guest": false,
          "id": 0,
          "collectionId": 0,
          "type": 0,
          "referenceAttribute2": 0,
          "customProperties": {
            "value": "string",
            "key": "key"
          },
          "availableResend": 0,
          "maximumOTPAttempt": 0
        }
      ]
    },
    "collectionId": "695",
    "eventType": "userservice/customproperty/patch",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

CreateNotes

Event Type: userservice/notes/create


{
  "version": "0",
  "id": "1d4c3858-8d9d-c051-ae02-5f7982337c23",
  "detail-type": "userservice/notes/create",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:56:38Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "58",
    "timestamp": 1716357398662,
    "payload": {
      "notes": {
        "id": 58,
        "collectionId": 686,
        "userId": 12079,
        "title": "jsGI0VE",
        "description": "Notes08371f5",
        "createdBy": 1,
        "createdOn": 1716357398659,
        "updatedBy": 1,
        "updatedOn": 1716357398659
      }
    },
    "collectionId": "686",
    "eventType": "userservice/notes/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }

DeleteNotes

Event Type: userservice/notes/delete


{
  "version": "0",
  "id": "2054b15a-7328-e64d-bc4c-b0312b790da8",
  "detail-type": "userservice/notes/delete",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:56:49Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "58",
    "timestamp": 1716357409585,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "NOTES DELETED SUCCESSFULLY",
      "timeStamp": "1716357409577"
    },
    "collectionId": "686",
    "eventType": "userservice/notes/delete",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

CreateSecurityQuestion

Event Type: userservice/securityquestion/create


{
  "version": "0",
  "id": "4f0d038d-551c-3494-6040-55de33cda054",
  "detail-type": "userservice/securityquestion/create",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:57:48Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357468720,
    "payload": {
      "responseCode": "USER_234",
      "responseMessage": "User Password Updated by Security Question Successfully"
    },
    "collectionId": "690",
    "eventType": "userservice/securityquestion/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN",
      "ROLE_REG_USER",
      "ROLE_GUEST"
    ],
    "channel": "SF_USER"
  }
}

GetAllSecurityQuestions

Event Type: userservice/securityquestions/get


{
  "version": "0",
  "id": "fd45f140-99f1-add4-dfcd-a51bbb96473e",
  "detail-type": "userservice/securityquestions/get",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:56:09Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357369483,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success",
      "users": [
        {
          "guest": false,
          "id": 0,
          "collectionId": 0,
          "type": 0,
          "referenceAttribute2": 0,
          "availableResend": 0,
          "maximumOTPAttempt": 0
        }
      ]
    },
    "collectionId": "686",
    "eventType": "userservice/securityquestions/get",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

UpdateSecurityQuestions

Event Type: userservice/securityquestions/update


{
  "version": "0",
  "id": "0a50b3d2-ed48-9ef1-8259-7410e2d45645",
  "detail-type": "userservice/securityquestions/update",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:56:59Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357419615,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success",
      "users": [
        {
          "guest": false,
          "id": 0,
          "collectionId": 0,
          "type": 0,
          "referenceAttribute2": 0,
          "availableResend": 0,
          "maximumOTPAttempt": 0
        }
      ]
    },
    "collectionId": "686",
    "eventType": "userservice/securityquestions/update",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

CreateUser

Event Type: userservice/user/create


{
  "version": "0",
  "id": "0c651fec-956b-fb4c-5ea8-ade076aea4ae",
  "detail-type": "userservice/user/create",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:55:57Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357357695,
    "payload": {
      "createdUsers": [
        {
          "guest": false,
          "id": 12079,
          "collectionId": 686,
          "status": "ACTIVE",
          "type": 1,
          "dateOfBirth": "10-12-2007",
          "gender": "female",
          "firstName": "Brock",
          "lastName": "Hall",
          "phoneNumber": "1665010949",
          "referenceAttribute2": 0,
          "email": "email_1682417086267@skava.com",
          "photo": "Sample 3",
          "preferences": "sms",
          "createdDate": 1716357357000,
          "updatedDate": 1716357357000,
          "identities": [
            {
              "id": 11396,
              "identity": "1665010949",
              "type": 1,
              "identityType": "DEFAULT",
              "status": "ACTIVE"
            },
            {
              "id": 11397,
              "identity": "email_1682417086267@skava.com",
              "type": 1,
              "identityType": "DEFAULT",
              "status": "ACTIVE"
            }
          ],
          "customProperties": {
            "bearerToken": "cfbc68bea94cd2db22346e48318ce18a31b1441580f13bddac266a013ca23382"
          },
          "addresses": [
            {
              "id": 2856,
              "type": "shipping",
              "firstName": "Brock",
              "middleName": "k",
              "lastName": "Hall",
              "phone": "2739092659",
              "email": "Email_1716357357588@skava.com",
              "street1": "822 NorthNash Ave.",
              "street2": "string",
              "street3": "string",
              "city": "Guayama",
              "country": "Tunisia",
              "state": "Nebraska",
              "zipCode": "05249",
              "validated": false,
              "createdDate": 1716357357000,
              "updatedDate": 1716357357000,
              "overridden": false,
              "validatedOn": 0,
              "createdBy": 0,
              "updatedBy": 0,
              "default": false
            }
          ],
          "availableResend": 0,
          "maximumOTPAttempt": 0
        }
      ],
      "existingUsers": [
        
      ]
    },
    "collectionId": "686",
    "eventType": "userservice/user/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

DeleteUser

Event Type: userservice/user/delete


{
  "version": "0",
  "id": "1e3fe950-64e5-10fa-61c1-c3a9d69fd5ff",
  "detail-type": "userservice/user/delete",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:57:11Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "12079",
    "timestamp": 1716357431917,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success"
    },
    "collectionId": "686",
    "eventType": "userservice/user/delete",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

UpdateUser

Event Type: userservice/user/update


{
  "version": "0",
  "id": "d3a4e107-9b02-8c72-42ac-982553c0b8be",
  "detail-type": "userservice/user/update",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:56:12Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357372969,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success",
      "users": [
        {
          "guest": false,
          "id": 12079,
          "collectionId": 686,
          "status": "ACTIVE",
          "type": 1,
          "dateOfBirth": "10-12-2007",
          "gender": "female",
          "firstName": "Brock",
          "lastName": "Hall",
          "phoneNumber": "1665010949",
          "referenceAttribute2": 0,
          "email": "email_1716357372916@skava.com",
          "photo": "Sample 3",
          "preferences": "sms",
          "createdDate": 1716357358000,
          "updatedDate": 1716357358000,
          "identities": [
            {
              "id": 11396,
              "identity": "1665010949",
              "type": 1,
              "identityType": "DEFAULT",
              "status": "ACTIVE"
            },
            {
              "id": 11397,
              "identity": "email_1716357372916@skava.com",
              "type": 1,
              "identityType": "DEFAULT",
              "status": "ACTIVE"
            }
          ],
          "customProperties": {
            
          },
          "addresses": [
            {
              "id": 2856,
              "type": "shipping",
              "firstName": "Brock",
              "middleName": "k",
              "lastName": "Hall",
              "phone": "2739092659",
              "email": "Email_1716357357588@skava.com",
              "street1": "822 NorthNash Ave.",
              "street2": "string",
              "street3": "string",
              "city": "Guayama",
              "country": "Tunisia",
              "county": "string",
              "state": "Nebraska",
              "zipCode": "05249",
              "validated": false,
              "createdDate": 1716357358000,
              "updatedDate": 1716357358000,
              "overridden": false,
              "validatedOn": 0,
              "createdBy": 0,
              "updatedBy": 0,
              "properties": {
                
              },
              "default": false
            }
          ],
          "availableResend": 0,
          "maximumOTPAttempt": 0
        }
      ]
    },
    "collectionId": "686",
    "eventType": "userservice/user/update",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

DeleteUserConsent

Event Type: userservice/userconsent/delete


{
  "version": "0",
  "id": "1a72b8dd-c6e8-1a88-6786-12528b4159d2",
  "detail-type": "userservice/userconsent/delete",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:57:05Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "74",
    "timestamp": 1716357425048,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success"
    },
    "collectionId": "686",
    "eventType": "userservice/userconsent/delete",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

CreateUserNotification

Event Type: userservice/usernotification/create


{
  "version": "0",
  "id": "2c998221-a73c-302d-700c-7978c0521df4",
  "detail-type": "userservice/usernotification/create",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:57:35Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "timestamp": 1716357455037,
    "payload": {
      "responseCode": "USER_233",
      "responseMessage": "Generate User Notification Successfully"
    },
    "collectionId": "689",
    "eventType": "userservice/usernotification/create",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN",
      "ROLE_REG_USER",
      "ROLE_GUEST"
    ],
    "channel": "SF_USER"
  }
}

UpdateUserPassword

Event Type: userservice/userpassword/patch


{
  "version": "0",
  "id": "4f28277c-6c20-abe3-2b2a-43886f6cc303",
  "detail-type": "userservice/userpassword/patch",
  "source": "userservice",
  "account": "277827593990",
  "time": "2024-05-22T05:56:54Z",
  "region": "us-east-1",
  "resources": [
    
  ],
  "detail": {
    "id": "12079",
    "timestamp": 1716357414053,
    "payload": {
      "responseCode": "USER_0",
      "responseMessage": "Success"
    },
    "collectionId": "686",
    "eventType": "userservice/userpassword/patch",
    "userId": "1",
    "actOnBehalfOfUser": 0,
    "roles": [
      "ROLE_SUPER_ADMIN"
    ],
    "channel": "CSR"
  }
}

Internal Events via RabbitMQ/AWS MQ

The following events communicate with the internal microservices.

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.	email
`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
2024-05-24 | JP – Added external events for 8.17.4 release.
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.

Events – Customers (User)

External Events via EventBridge

List of Events

Payload

CreateActivation

UpdateActivation

DeleteAddress

CreateAddresses

CreateConsent

DeleteConsent

UpdateConsents

CreateCredential

DeleteCustomProperty

UpdateCustomProperty

CreateNotes

DeleteNotes

CreateSecurityQuestion

GetAllSecurityQuestions

UpdateSecurityQuestions

CreateUser

DeleteUser

UpdateUser

DeleteUserConsent

CreateUserNotification

UpdateUserPassword

Internal Events via RabbitMQ/AWS MQ

List of Events

Payload Models

UserCreated

ResetPassword

ValidateActivation

ValidateResetPassword

DeleteUser

UpdateUser

ResendActivation

SendNotification

ValidateNotification

UserMFALogin

UserMerge