Application
Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.
Events
application/user/create/v1
# this event is triggered when user is created
application/user/update/v1
# this event is triggered when user is updated
application/user/delete/v1
# this event is triggered when user is deleted
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
array of object
Required
Array of Properties
user
object
Required
Properties
id
string
__v
integer
_id
string
Required
dob
string|null
meta
string|object
Meta information for users
active
boolean
Required
Shows whether user is blocked or unblocked
emails
array of Undefined Type
Required
User emails' array
gender
string|null
User gender
status
string
Required
Status of the user, e.g. activated
userId
string
User's unique ID
archive
boolean
Required
Shows whether user is deleted or present
user_id
string
Required
User's unique ID
lastName
string
Last name of the user
username
string
Required
User name of the user
createdAt
string
firstName
string
First name of the user
last_name
string
Last name of the user
updatedAt
string
created_at
string
Required
externalId
string
first_name
string
First name of the user
is_created
boolean
Required
Shows if it is a new user or updated user
updated_at
string
Required
accountType
string
Indicates if user is created by system or by normal sign up flow
external_id
string
account_type
string
Required
Indicates if user is created by system or by normal sign up flow
phoneNumbers
array of Undefined Type
User phone numbers' array
applicationId
string
Unique ID of the application
phone_numbers
array of Undefined Type
Required
User phone numbers' array
profilePicUrl
string
Link to the profile picture of the user
application_id
string
Required
Unique ID of the application
profile_pic_url
string
Link to the profile picture of the user
hasOldPasswordHash
boolean
has_old_password_hash
boolean
consent
object
User's consent information including privacy policy acceptance
Properties
privacy_policy
object
Properties
value
boolean
Whether the user has consented to the privacy policy
updated_at
string
| date-time
When the consent was last updated
socialAccounts
array of Undefined Type
Required
User's social login details and source of user account creation from another platform
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "array",76 "items": {77 "type": "object",78 "required": [79 "user",80 "socialAccounts"81 ],82 "properties": {83 "user": {84 "type": "object",85 "required": [86 "active",87 "archive",88 "status",89 "_id",90 "emails",91 "username",92 "account_type",93 "phone_numbers",94 "application_id",95 "user_id",96 "created_at",97 "updated_at",98 "is_created"99 ],100 "properties": {101 "id": {102 "type": "string"103 },104 "__v": {105 "type": "integer"106 },107 "_id": {108 "type": "string"109 },110 "dob": {111 "type": [112 "string",113 "null"114 ]115 },116 "meta": {117 "type": [118 "string",119 "object"120 ],121 "description": "Meta information for users"122 },123 "active": {124 "type": "boolean",125 "description": "Shows whether user is blocked or unblocked"126 },127 "emails": {128 "type": "array",129 "items": [130 {131 "type": "object",132 "required": [133 "active",134 "primary",135 "verified",136 "email"137 ],138 "properties": {139 "email": {140 "type": "string"141 },142 "active": {143 "type": "boolean"144 },145 "primary": {146 "type": "boolean"147 },148 "verified": {149 "type": "boolean"150 }151 }152 }153 ],154 "description": "User emails' array"155 },156 "gender": {157 "type": [158 "string",159 "null"160 ],161 "description": "User gender"162 },163 "status": {164 "type": "string",165 "description": "Status of the user, e.g. activated"166 },167 "userId": {168 "type": "string",169 "description": "User's unique ID"170 },171 "archive": {172 "type": "boolean",173 "description": "Shows whether user is deleted or present"174 },175 "user_id": {176 "type": "string",177 "description": "User's unique ID"178 },179 "lastName": {180 "type": "string",181 "description": "Last name of the user"182 },183 "username": {184 "type": "string",185 "description": "User name of the user"186 },187 "createdAt": {188 "type": "string"189 },190 "firstName": {191 "type": "string",192 "description": "First name of the user"193 },194 "last_name": {195 "type": "string",196 "description": "Last name of the user"197 },198 "updatedAt": {199 "type": "string"200 },201 "created_at": {202 "type": "string"203 },204 "externalId": {205 "type": "string"206 },207 "first_name": {208 "type": "string",209 "description": "First name of the user"210 },211 "is_created": {212 "type": "boolean",213 "description": "Shows if it is a new user or updated user"214 },215 "updated_at": {216 "type": "string"217 },218 "accountType": {219 "type": "string",220 "description": "Indicates if user is created by system or by normal sign up flow"221 },222 "external_id": {223 "type": "string"224 },225 "account_type": {226 "type": "string",227 "description": "Indicates if user is created by system or by normal sign up flow"228 },229 "phoneNumbers": {230 "type": "array",231 "items": [232 {233 "type": "object",234 "required": [235 "active",236 "primary",237 "verified",238 "phone",239 "countryCode",240 "country_code"241 ],242 "properties": {243 "phone": {244 "type": "string"245 },246 "active": {247 "type": "boolean"248 },249 "primary": {250 "type": "boolean"251 },252 "verified": {253 "type": "boolean"254 },255 "countryCode": {256 "type": "integer"257 },258 "country_code": {259 "type": "integer"260 }261 }262 }263 ],264 "description": "User phone numbers' array"265 },266 "applicationId": {267 "type": "string",268 "description": "Unique ID of the application"269 },270 "phone_numbers": {271 "type": "array",272 "items": [273 {274 "type": "object",275 "required": [276 "active",277 "primary",278 "verified",279 "phone",280 "countryCode",281 "country_code"282 ],283 "properties": {284 "phone": {285 "type": "string",286 "description": "Phone number of user"287 },288 "active": {289 "type": "boolean",290 "description": "Marked true if number is active"291 },292 "primary": {293 "type": "boolean",294 "description": "Marked true if number is primary. Primary numbers cannot be removed from account"295 },296 "verified": {297 "type": "boolean",298 "description": "Marked true if number is verified by user"299 },300 "countryCode": {301 "type": "integer"302 },303 "country_code": {304 "type": "integer",305 "description": "Country code of user phone number"306 }307 }308 }309 ],310 "description": "User phone numbers' array"311 },312 "profilePicUrl": {313 "type": "string",314 "description": "Link to the profile picture of the user"315 },316 "application_id": {317 "type": "string",318 "description": "Unique ID of the application"319 },320 "profile_pic_url": {321 "type": "string",322 "description": "Link to the profile picture of the user"323 },324 "hasOldPasswordHash": {325 "type": "boolean"326 },327 "has_old_password_hash": {328 "type": "boolean"329 },330 "consent": {331 "type": "object",332 "properties": {333 "privacy_policy": {334 "type": "object",335 "properties": {336 "value": {337 "type": "boolean",338 "description": "Whether the user has consented to the privacy policy"339 },340 "updated_at": {341 "type": "string",342 "format": "date-time",343 "description": "When the consent was last updated"344 }345 }346 }347 },348 "description": "User's consent information including privacy policy acceptance"349 }350 }351 },352 "socialAccounts": {353 "type": "array",354 "items": {},355 "description": "User's social login details and source of user account creation from another platform"356 }357 }358 }359 }360 }361}
Payload Example
1{2 "event": {3 "trace_id": [4 "deadlock.5904b351-f1bc-11ee-8c89-23e32fd9851b"5 ],6 "name": "user",7 "type": "create",8 "version": "1",9 "created_timestamp": 1712150174469,10 "id": "RMeNKW2ieZrNFPMJ99uEUYhNLekjtKoKKGyrGBTnObo=",11 "category": "application"12 },13 "company_id": 2326,14 "application_id": [15 "62d798d9578cc9c73cc2f834",16 "*"17 ],18 "contains": [19 "0"20 ],21 "payload": [22 {23 "user": {24 "_id": "660d569e3f1730ce55d06690",25 "username": "918888888888_12345",26 "firstName": "test",27 "lastName": "test",28 "phoneNumbers": [29 {30 "phone": "8888888888",31 "countryCode": 91,32 "active": true,33 "primary": true,34 "verified": true,35 "country_code": 9136 }37 ],38 "emails": [39 {40 "email": "test@example.com",41 "active": true,42 "primary": true,43 "verified": true44 }45 ],46 "gender": "male",47 "accountType": "user",48 "active": true,49 "archive": false,50 "status": "activated",51 "profilePicUrl": "https://hdn-1.fynd.com/default-profile_nxhzui.png",52 "hasOldPasswordHash": false,53 "meta": "{\"email_id\":\"test@example.com\",\"user_guid\":\"e8315b98-9e8e-4fd9-899e-4e95536af985\",\"token\":\"\",\"epoch_timestamp\":\"\",\"is_custom_image\":\"0\",\"user\":{\"name\":\"test test\",\"mobile_no\":\"1111111111\",\"social_user_image\":\"\",\"dob\":\"1998-10-02\",\"gender\":\"\",\"city_id\":\"\",\"state_id\":\"\",\"pincode\":\"\"}}",54 "userId": "660d569e3f1730ce55d06690",55 "applicationId": "62d798d9578cc9c73cc2f834",56 "createdAt": "2024-04-03T13:16:14.440Z",57 "updatedAt": "2024-04-03T13:16:14.440Z",58 "__v": 0,59 "first_name": "test",60 "last_name": "test",61 "phone_numbers": [62 {63 "phone": "8888888888",64 "countryCode": 91,65 "active": true,66 "primary": true,67 "verified": true,68 "country_code": 9169 }70 ],71 "account_type": "user",72 "profile_pic_url": "https://hdn-1.fynd.com/default-profile_nxhzui.png",73 "has_old_password_hash": false,74 "user_id": "660d569e3f1730ce55d06690",75 "application_id": "62d798d9578cc9c73cc2f834",76 "created_at": "2024-04-03T13:16:14.440Z",77 "updated_at": "2024-04-03T13:16:14.440Z",78 "is_created": true79 },80 "socialAccounts": []81 }82 ]83}
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
array of object
Required
Array of Properties
user
object
Required
Properties
id
string
__v
integer
_id
string
Required
dob
string|null
meta
string|object
Meta information for users
active
boolean
Required
Shows whether user is blocked or unblocked
emails
array of Undefined Type
Required
User emails' array
gender
string|null
User gender
status
string
Required
Status of the user, e.g. activated
userId
string
User's unique ID
archive
boolean
Required
Shows whether user is deleted or present
user_id
string
Required
User's unique ID
lastName
string
Last name of the user
username
string
Required
User name of the user
createdAt
string
firstName
string
First name of the user
last_name
string
Last name of the user
updatedAt
string
created_at
string
Required
externalId
string
first_name
string
First name of the user
is_created
boolean
Required
Shows if it is a new user or updated user
updated_at
string
Required
accountType
string
external_id
string
account_type
string
Required
phoneNumbers
array of Undefined Type
User phone numbers' array
applicationId
string
Unique ID of the application
phone_numbers
array of Undefined Type
Required
User phone numbers' array
profilePicUrl
string
Link to the profile picture of the user
application_id
string
Required
Unique ID of the application
profile_pic_url
string
Link to the profile picture of the user
hasOldPasswordHash
boolean
has_old_password_hash
boolean
consent
object
User's consent information including privacy policy acceptance
Properties
privacy_policy
object
Properties
value
boolean
Whether the user has consented to the privacy policy
updated_at
string
| date-time
When the consent was last updated
socialAccounts
array of Undefined Type
Required
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "array",76 "items": {77 "type": "object",78 "required": [79 "user",80 "socialAccounts"81 ],82 "properties": {83 "user": {84 "type": "object",85 "required": [86 "active",87 "archive",88 "status",89 "_id",90 "emails",91 "username",92 "account_type",93 "phone_numbers",94 "application_id",95 "user_id",96 "created_at",97 "updated_at",98 "is_created"99 ],100 "properties": {101 "id": {102 "type": "string"103 },104 "__v": {105 "type": "integer"106 },107 "_id": {108 "type": "string"109 },110 "dob": {111 "type": [112 "string",113 "null"114 ]115 },116 "meta": {117 "type": [118 "string",119 "object"120 ],121 "description": "Meta information for users"122 },123 "active": {124 "type": "boolean",125 "description": "Shows whether user is blocked or unblocked"126 },127 "emails": {128 "type": "array",129 "items": [130 {131 "type": "object",132 "required": [133 "active",134 "primary",135 "verified",136 "email"137 ],138 "properties": {139 "email": {140 "type": "string"141 },142 "active": {143 "type": "boolean"144 },145 "primary": {146 "type": "boolean"147 },148 "verified": {149 "type": "boolean"150 }151 }152 }153 ],154 "description": "User emails' array"155 },156 "gender": {157 "type": [158 "string",159 "null"160 ],161 "description": "User gender"162 },163 "status": {164 "type": "string",165 "description": "Status of the user, e.g. activated"166 },167 "userId": {168 "type": "string",169 "description": "User's unique ID"170 },171 "archive": {172 "type": "boolean",173 "description": "Shows whether user is deleted or present"174 },175 "user_id": {176 "type": "string",177 "description": "User's unique ID"178 },179 "lastName": {180 "type": "string",181 "description": "Last name of the user"182 },183 "username": {184 "type": "string",185 "description": "User name of the user"186 },187 "createdAt": {188 "type": "string"189 },190 "firstName": {191 "type": "string",192 "description": "First name of the user"193 },194 "last_name": {195 "type": "string",196 "description": "Last name of the user"197 },198 "updatedAt": {199 "type": "string"200 },201 "created_at": {202 "type": "string"203 },204 "externalId": {205 "type": "string"206 },207 "first_name": {208 "type": "string",209 "description": "First name of the user"210 },211 "is_created": {212 "type": "boolean",213 "description": "Shows if it is a new user or updated user"214 },215 "updated_at": {216 "type": "string"217 },218 "accountType": {219 "type": "string"220 },221 "external_id": {222 "type": "string"223 },224 "account_type": {225 "type": "string"226 },227 "phoneNumbers": {228 "type": "array",229 "items": [230 {231 "type": "object",232 "required": [233 "active",234 "primary",235 "verified",236 "phone",237 "countryCode",238 "country_code"239 ],240 "properties": {241 "phone": {242 "type": "string"243 },244 "active": {245 "type": "boolean"246 },247 "primary": {248 "type": "boolean"249 },250 "verified": {251 "type": "boolean"252 },253 "countryCode": {254 "type": "integer"255 },256 "country_code": {257 "type": "integer"258 }259 }260 }261 ],262 "description": "User phone numbers' array"263 },264 "applicationId": {265 "type": "string",266 "description": "Unique ID of the application"267 },268 "phone_numbers": {269 "type": "array",270 "items": [271 {272 "type": "object",273 "required": [274 "active",275 "primary",276 "verified",277 "phone",278 "countryCode",279 "country_code"280 ],281 "properties": {282 "phone": {283 "type": "string"284 },285 "active": {286 "type": "boolean"287 },288 "primary": {289 "type": "boolean"290 },291 "verified": {292 "type": "boolean"293 },294 "countryCode": {295 "type": "integer"296 },297 "country_code": {298 "type": "integer"299 }300 }301 }302 ],303 "description": "User phone numbers' array"304 },305 "profilePicUrl": {306 "type": "string",307 "description": "Link to the profile picture of the user"308 },309 "application_id": {310 "type": "string",311 "description": "Unique ID of the application"312 },313 "profile_pic_url": {314 "type": "string",315 "description": "Link to the profile picture of the user"316 },317 "hasOldPasswordHash": {318 "type": "boolean"319 },320 "has_old_password_hash": {321 "type": "boolean"322 },323 "consent": {324 "type": "object",325 "properties": {326 "privacy_policy": {327 "type": "object",328 "properties": {329 "value": {330 "type": "boolean",331 "description": "Whether the user has consented to the privacy policy"332 },333 "updated_at": {334 "type": "string",335 "format": "date-time",336 "description": "When the consent was last updated"337 }338 }339 }340 },341 "description": "User's consent information including privacy policy acceptance"342 }343 }344 },345 "socialAccounts": {346 "type": "array",347 "items": {}348 }349 }350 }351 }352 }353}
Payload Example
1{2 "event": {3 "trace_id": [4 "deadlock.71a89261-f198-11ee-9442-013da6cd3006"5 ],6 "name": "user",7 "type": "update",8 "version": "1",9 "created_timestamp": 1712134753926,10 "id": "V4GnyhAWzn0zPksqPxCeIQgwRfruO2mWQfu7Gka0c3A=",11 "category": "application"12 },13 "company_id": 5842,14 "application_id": [15 "6523fa5f41f4eb4c10a1d869",16 "*"17 ],18 "contains": [19 "0"20 ],21 "payload": [22 {23 "user": {24 "_id": "6604625d5e26b4665dd0ee65",25 "username": "test_example_com_12345",26 "firstName": "test",27 "lastName": "test",28 "phoneNumbers": [29 {30 "phone": "8888888888",31 "countryCode": 91,32 "active": true,33 "primary": true,34 "verified": true,35 "country_code": 9136 }37 ],38 "emails": [39 {40 "email": "test@example.com",41 "active": true,42 "primary": true,43 "verified": true44 }45 ],46 "gender": "female",47 "accountType": "user",48 "active": true,49 "archive": false,50 "status": "activated",51 "profilePicUrl": "https://hdn-1.fynd.com/default-profile_nxhzui.png",52 "hasOldPasswordHash": false,53 "userId": "6604625d5e26b4665dd0ee65",54 "applicationId": "6523fa5f41f4eb4c10a1d869",55 "createdAt": "2024-03-27T18:15:57.458Z",56 "updatedAt": "2024-04-03T08:59:13.909Z",57 "__v": 0,58 "meta": "{\"_id\":\"6604625d5e26b4665dd0ee65\",\"username\":\"test\",\"emails\":[{\"email\":\"test@example.com\",\"active\":true,\"primary\":true,\"verified\":true}],\"gender\":\"female\",\"active\":true,\"first_name\":\"test\",\"last_name\":\"test\",\"phone_numbers\":[{\"phone\":\"1111111111\",\"active\":true,\"primary\":true,\"verified\":true,\"country_code\":91}],\"account_type\":\"user\",\"profile_pic_url\":\"https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/theme/pictures/free/original/default-profile_nxhzui.png\",\"user_id\":\"6604625d5e26b4665dd0ee65\",\"application_id\":\"6523fa5f41f4eb4c10a1d869\",\"created_at\":\"2024-03-27T18:15:57.458Z\",\"updated_at\":\"2024-03-27T18:15:57.458Z\",\"meta\":\"{}\",\"REVIEWS\":{\"9805785\":{\"ORDERS\":{\"FY660CF77F0EE4DB5EF0\":{\"17121258248161234467\":{\"quantity\":1}}},\"VERIFIED_REVIEW_COUNT\":0,\"REVIEW_COUNT\":0},\"9929758\":{\"ORDERS\":{\"FY660462C20EAD78A2F7\":{\"17115634590311655479\":{\"quantity\":1}}},\"VERIFIED_REVIEW_COUNT\":0,\"REVIEW_COUNT\":0}}}",59 "first_name": "test",60 "last_name": "test",61 "phone_numbers": [62 {63 "phone": "8888888888",64 "countryCode": 91,65 "active": true,66 "primary": true,67 "verified": true,68 "country_code": 9169 }70 ],71 "account_type": "user",72 "profile_pic_url": "https://hdn-1.fynd.com/default-profile_nxhzui.png",73 "has_old_password_hash": false,74 "user_id": "6604625d5e26b4665dd0ee65",75 "application_id": "6523fa5f41f4eb4c10a1d869",76 "created_at": "2024-03-27T18:15:57.458Z",77 "updated_at": "2024-04-03T08:59:13.909Z",78 "is_created": false79 },80 "socialAccounts": []81 }82 ]83}
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
array of object
Required
Array of Properties
user
object
Required
Properties
id
string
__v
integer
_id
string
Required
dob
string|null
meta
string|object
Meta information for users
active
boolean
Required
Shows whether user is blocked or unblocked
emails
array of Undefined Type
Required
User emails' array
gender
string|null
User gender
status
string
Required
Status of the user, e.g. activated
userId
string
User's unique ID
archive
boolean
Required
Shows whether user is deleted or present
user_id
string
Required
User's unique ID
lastName
string
Last name of the user
username
string
Required
User name of the user
createdAt
string
firstName
string
First name of the user
last_name
string
Last name of the user
updatedAt
string
created_at
string
Required
externalId
string
first_name
string
First name of the user
updated_at
string
Required
accountType
string
external_id
string
account_type
string
Required
phoneNumbers
array of Undefined Type
User phone numbers' array
applicationId
string
Unique ID of the application
phone_numbers
array of Undefined Type
Required
User phone numbers' array
profilePicUrl
string
Link to the profile picture of the user
application_id
string
Required
Unique ID of the application
profile_pic_url
string
Link to the profile picture of the user
hasOldPasswordHash
boolean
has_old_password_hash
boolean
consent
object
User's consent information including privacy policy acceptance
Properties
privacy_policy
object
Properties
value
boolean
Whether the user has consented to the privacy policy
updated_at
string
| date-time
When the consent was last updated
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "array",76 "items": {77 "type": "object",78 "required": [79 "user"80 ],81 "properties": {82 "user": {83 "type": "object",84 "required": [85 "active",86 "archive",87 "status",88 "_id",89 "emails",90 "username",91 "account_type",92 "phone_numbers",93 "application_id",94 "user_id",95 "created_at",96 "updated_at"97 ],98 "properties": {99 "id": {100 "type": "string"101 },102 "__v": {103 "type": "integer"104 },105 "_id": {106 "type": "string"107 },108 "dob": {109 "type": [110 "string",111 "null"112 ]113 },114 "meta": {115 "type": [116 "string",117 "object"118 ],119 "description": "Meta information for users"120 },121 "active": {122 "type": "boolean",123 "description": "Shows whether user is blocked or unblocked"124 },125 "emails": {126 "type": "array",127 "items": [128 {129 "type": "object",130 "required": [131 "active",132 "primary",133 "verified",134 "email"135 ],136 "properties": {137 "email": {138 "type": "string"139 },140 "active": {141 "type": "boolean"142 },143 "primary": {144 "type": "boolean"145 },146 "verified": {147 "type": "boolean"148 }149 }150 }151 ],152 "description": "User emails' array"153 },154 "gender": {155 "type": [156 "string",157 "null"158 ],159 "description": "User gender"160 },161 "status": {162 "type": "string",163 "description": "Status of the user, e.g. activated"164 },165 "userId": {166 "type": "string",167 "description": "User's unique ID"168 },169 "archive": {170 "type": "boolean",171 "description": "Shows whether user is deleted or present"172 },173 "user_id": {174 "type": "string",175 "description": "User's unique ID"176 },177 "lastName": {178 "type": "string",179 "description": "Last name of the user"180 },181 "username": {182 "type": "string",183 "description": "User name of the user"184 },185 "createdAt": {186 "type": "string"187 },188 "firstName": {189 "type": "string",190 "description": "First name of the user"191 },192 "last_name": {193 "type": "string",194 "description": "Last name of the user"195 },196 "updatedAt": {197 "type": "string"198 },199 "created_at": {200 "type": "string"201 },202 "externalId": {203 "type": "string"204 },205 "first_name": {206 "type": "string",207 "description": "First name of the user"208 },209 "updated_at": {210 "type": "string"211 },212 "accountType": {213 "type": "string"214 },215 "external_id": {216 "type": "string"217 },218 "account_type": {219 "type": "string"220 },221 "phoneNumbers": {222 "type": "array",223 "items": [224 {225 "type": "object",226 "required": [227 "active",228 "primary",229 "verified",230 "phone",231 "country_code"232 ],233 "properties": {234 "phone": {235 "type": "string"236 },237 "active": {238 "type": "boolean"239 },240 "primary": {241 "type": "boolean"242 },243 "verified": {244 "type": "boolean"245 },246 "country_code": {247 "type": "integer"248 }249 }250 }251 ],252 "description": "User phone numbers' array"253 },254 "applicationId": {255 "type": "string",256 "description": "Unique ID of the application"257 },258 "phone_numbers": {259 "type": "array",260 "items": [261 {262 "type": "object",263 "required": [264 "active",265 "primary",266 "verified",267 "phone",268 "country_code"269 ],270 "properties": {271 "phone": {272 "type": "string"273 },274 "active": {275 "type": "boolean"276 },277 "primary": {278 "type": "boolean"279 },280 "verified": {281 "type": "boolean"282 },283 "country_code": {284 "type": "integer"285 }286 }287 }288 ],289 "description": "User phone numbers' array"290 },291 "profilePicUrl": {292 "type": "string",293 "description": "Link to the profile picture of the user"294 },295 "application_id": {296 "type": "string",297 "description": "Unique ID of the application"298 },299 "profile_pic_url": {300 "type": "string",301 "description": "Link to the profile picture of the user"302 },303 "hasOldPasswordHash": {304 "type": "boolean"305 },306 "has_old_password_hash": {307 "type": "boolean"308 },309 "consent": {310 "type": "object",311 "properties": {312 "privacy_policy": {313 "type": "object",314 "properties": {315 "value": {316 "type": "boolean",317 "description": "Whether the user has consented to the privacy policy"318 },319 "updated_at": {320 "type": "string",321 "format": "date-time",322 "description": "When the consent was last updated"323 }324 }325 }326 },327 "description": "User's consent information including privacy policy acceptance"328 }329 }330 }331 }332 }333 }334 }335}
Payload Example
1{2 "event": {3 "trace_id": [4 "deadlock.3650e0f1-f14d-11ee-aaf4-6512b1239800"5 ],6 "name": "user",7 "type": "delete",8 "version": "1",9 "created_timestamp": 1712102442111,10 "id": "xAcjtwW4TJxDgBIXs7JpsYI8iV4JzNsn2pQzHniSVwU=",11 "category": "application"12 },13 "company_id": 1,14 "application_id": [15 "000000000000000000000003",16 "*"17 ],18 "contains": [19 "0"20 ],21 "payload": [22 {23 "user": {24 "_id": "65ded54761afa80deb0e49d9",25 "username": "918888888888_12345",26 "emails": [],27 "gender": "male",28 "active": true,29 "archive": true,30 "status": "deleted",31 "__v": 0,32 "first_name": "test",33 "last_name": "test",34 "phone_numbers": [35 {36 "phone": "8888888888",37 "active": true,38 "primary": true,39 "verified": true,40 "country_code": 9141 }42 ],43 "account_type": "user",44 "profile_pic_url": "https://hdn-1.fynd.com/default-profile_nxhzui.png",45 "has_old_password_hash": false,46 "user_id": "65ded54761afa80deb0e49d9",47 "application_id": "000000000000000000000003",48 "created_at": "2024-02-28T06:40:07.084Z",49 "updated_at": "2024-03-04T08:07:10.021Z",50 "is_created": false51 }52 }53 ]54}