User
Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If attribute value(s) of a user is created for sales channel.
This event will be generated when any attributes for a user is created, updated or deleted
Events
user/user_attributes/create/v1
# This event is triggered when a user attribute is created
user/user_attributes/update/v1
# This event is triggered when a user attribute value is updated
user/user_attributes/delete/v1
# This event is triggered when a user attribute 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 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 {78 "type": "object",79 "properties": {80 "id": {81 "type": "string",82 "description": "Uniquely generated id of user attribute definition"83 },84 "type": {85 "type": "string",86 "description": "This is field_type of the custom field definition.",87 "enum": [88 "number",89 "number_array",90 "string",91 "string_array",92 "boolean",93 "date",94 "date_time",95 "dropdown",96 "store_uid_array",97 "platform_user_array",98 "html_string",99 "image_url"100 ]101 },102 "application_id": {103 "type": "string",104 "description": "This is application id where this user attribute is created."105 },106 "attribute": {107 "type": "object",108 "properties": {109 "key": {110 "type": "string",111 "description": "Name of the attribute key"112 },113 "value": {114 "type": [115 "array",116 "string"117 ],118 "description": "This is value of the user attribute where the type is string in case of single value and array in case of multi value"119 }120 }121 },122 "created_at": {123 "type": "string",124 "description": "Timestamp of the user attribute value created in ISO format"125 },126 "modified_at": {127 "type": "string",128 "description": "Timestamp of the user attribute value updated in ISO format"129 },130 "customer_overridden": {131 "type": "boolean",132 "description": "Indicates if the user attribute value is customer overridden"133 },134 "name": {135 "type": "string",136 "description": "Name of the user attribute"137 },138 "updated_by": {139 "type": "string",140 "description": "User ID of the user who updated the user attribute value"141 },142 "user_attribute_definition_id": {143 "type": "string",144 "description": "User attribute definition ID"145 },146 "user_id": {147 "type": "string",148 "description": "User ID of the user whose attribute value is created or updated"149 }150 },151 "required": [152 "id",153 "type",154 "name",155 "application_id",156 "attribute",157 "user_attribute_definition_id"158 ]159 }160 ]161 }162 }163}
Payload Example
1{2 "event": {3 "trace_id": [4 "deadlock.9097f265-5999-409c-b9c1-69cac2e8561a"5 ],6 "name": "user_attributes",7 "type": "create",8 "version": "1",9 "created_timestamp": 1712058945287,10 "id": "3FAzwM7dMJENtA6gXZc0O581iY9WyePe0w5RL5GFVkE=",11 "category": "application",12 "referer": "fyndx1.de"13 },14 "company_id": 1,15 "application_id": "64aed377b1fd04565d0dff30",16 "contains": [17 "id",18 "attribute",19 "user_attribute_definition_id",20 "name",21 "user_id",22 "customer_overridden",23 "application_id",24 "type",25 "updated_by",26 "created_at",27 "modified_at"28 ],29 "payload": [30 {31 "id": "683c53db51d1c5988e10af77",32 "attribute": {33 "key": "text-attrbute",34 "value": [35 "Value 1"36 ]37 },38 "user_attribute_definition_id": "68246179cc946807ecada4c9",39 "name": "Text Attrbute",40 "user_id": "683c523151d1c5988e10af49",41 "application_id": "68121bfb070fc715501967e8",42 "customer_overridden": false,43 "type": "string_array",44 "updated_by": "fb0d4a48a36af2404b46d292",45 "created_at": "2025-06-01T13:21:31.673Z",46 "modified_at": "2025-06-01T13:21:31.673Z"47 }48 ]49}
Was this section helpful?
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 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 {78 "type": "object",79 "properties": {80 "id": {81 "type": "string",82 "description": "Uniquely generated id of user attribute definition"83 },84 "type": {85 "type": "string",86 "description": "This is field_type of the custom field definition.",87 "enum": [88 "number",89 "number_array",90 "string",91 "string_array",92 "boolean",93 "date",94 "date_time",95 "dropdown",96 "store_uid_array",97 "platform_user_array",98 "html_string",99 "image_url"100 ]101 },102 "application_id": {103 "type": "string",104 "description": "This is application id where this user attribute is created."105 },106 "attribute": {107 "type": "object",108 "properties": {109 "key": {110 "type": "string",111 "description": "Name of the attribute key"112 },113 "value": {114 "type": [115 "array",116 "string"117 ],118 "description": "This is value of the user attribute where the type is string in case of single value and array in case of multi value"119 }120 }121 },122 "created_at": {123 "type": "string",124 "description": "Timestamp of the user attribute value created in ISO format"125 },126 "modified_at": {127 "type": "string",128 "description": "Timestamp of the user attribute value updated in ISO format"129 },130 "customer_overridden": {131 "type": "boolean",132 "description": "Indicates if the user attribute value is customer overridden"133 },134 "name": {135 "type": "string",136 "description": "Name of the user attribute"137 },138 "updated_by": {139 "type": "string",140 "description": "User ID of the user who updated the user attribute value"141 },142 "user_attribute_definition_id": {143 "type": "string",144 "description": "User attribute definition ID"145 },146 "user_id": {147 "type": "string",148 "description": "User ID of the user whose attribute value is created or updated"149 }150 },151 "required": [152 "id",153 "type",154 "name",155 "application_id",156 "attribute",157 "user_attribute_definition_id"158 ]159 }160 ]161 }162 }163}
Payload Example
1{2 "event": {3 "trace_id": [4 "deadlock.9097f265-5999-409c-b9c1-69cac2e8561a"5 ],6 "name": "user_attributes",7 "type": "create",8 "version": "1",9 "created_timestamp": 1712058945287,10 "id": "3FAzwM7dMJENtA6gXZc0O581iY9WyePe0w5RL5GFVkE=",11 "category": "application",12 "referer": "fyndx1.de"13 },14 "company_id": 1,15 "application_id": "64aed377b1fd04565d0dff30",16 "contains": [17 "id",18 "attribute",19 "user_attribute_definition_id",20 "name",21 "user_id",22 "customer_overridden",23 "application_id",24 "type",25 "updated_by",26 "created_at",27 "modified_at"28 ],29 "payload": [30 {31 "id": "683c53db51d1c5988e10af77",32 "attribute": {33 "key": "text-attrbute",34 "value": [35 "Value 1"36 ]37 },38 "user_attribute_definition_id": "68246179cc946807ecada4c9",39 "name": "Text Attrbute",40 "user_id": "683c523151d1c5988e10af49",41 "application_id": "68121bfb070fc715501967e8",42 "customer_overridden": false,43 "type": "string_array",44 "updated_by": "fb0d4a48a36af2404b46d292",45 "created_at": "2025-06-01T13:21:31.673Z",46 "modified_at": "2025-06-01T13:21:31.673Z"47 }48 ]49}
Was this section helpful?
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 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 {78 "type": "object",79 "properties": {80 "id": {81 "type": "string",82 "description": "Uniquely generated id of user attribute definition"83 },84 "type": {85 "type": "string",86 "description": "This is field_type of the custom field definition.",87 "enum": [88 "number",89 "number_array",90 "string",91 "string_array",92 "boolean",93 "date",94 "date_time",95 "dropdown",96 "store_uid_array",97 "platform_user_array",98 "html_string",99 "image_url"100 ]101 },102 "application_id": {103 "type": "string",104 "description": "This is application id where this user attribute was is deleted."105 },106 "attribute": {107 "type": "object",108 "properties": {109 "key": {110 "type": "string",111 "description": "Name of the attribute key"112 },113 "value": {114 "type": [115 "array",116 "string"117 ],118 "description": "This is value of the user attribute where the type is string in case of single value and array in case of multi value"119 }120 }121 },122 "created_at": {123 "type": "string",124 "description": "Timestamp of the user attribute value was created in ISO format"125 },126 "modified_at": {127 "type": "string",128 "description": "Timestamp of the user attribute value was last updated in ISO format"129 },130 "customer_overridden": {131 "type": "boolean",132 "description": "Indicates if the user attribute value is customer overridden"133 },134 "name": {135 "type": "string",136 "description": "Name of the user attribute"137 },138 "updated_by": {139 "type": "string",140 "description": "User ID of the user who updated the user attribute value"141 },142 "user_attribute_definition_id": {143 "type": "string",144 "description": "User attribute definition ID"145 },146 "user_id": {147 "type": "string",148 "description": "User ID of the user whose attribute value is deleted"149 }150 },151 "required": [152 "id",153 "type",154 "name",155 "application_id",156 "user_attribute_definition_id"157 ]158 }159 ]160 }161 }162}
Payload Example
1{2 "event": {3 "trace_id": [4 "deadlock.9097f265-5999-409c-b9c1-69cac2e8561a"5 ],6 "name": "user_attributes",7 "type": "delete",8 "version": "1",9 "created_timestamp": 1712058945287,10 "id": "3FAzwM7dMJENtA6gXZc0O581iY9WyePe0w5RL5GFVkE=",11 "category": "application",12 "referer": "fyndx1.de"13 },14 "company_id": 1,15 "application_id": "64aed377b1fd04565d0dff30",16 "contains": [17 "id",18 "attribute",19 "user_attribute_definition_id",20 "name",21 "user_id",22 "customer_overridden",23 "application_id",24 "type",25 "updated_by",26 "created_at",27 "modified_at"28 ],29 "payload": [30 {31 "id": "683c53db51d1c5988e10af77",32 "attribute": {33 "key": "text-attrbute",34 "value": [35 "Value 1"36 ]37 },38 "user_attribute_definition_id": "68246179cc946807ecada4c9",39 "name": "Text Attrbute",40 "user_id": "683c523151d1c5988e10af49",41 "application_id": "68121bfb070fc715501967e8",42 "customer_overridden": false,43 "type": "string_array",44 "updated_by": "fb0d4a48a36af2404b46d292",45 "created_at": "2025-06-01T13:21:31.673Z",46 "modified_at": "2025-06-01T13:21:31.673Z"47 }48 ]49}
Was this section helpful?
A user attribute definition represents a configurable input field for storing attribute values per customer, and this event is triggered whenever it is created, updated, or deleted.
Events
user/user_attributes_definition/create/v1
# This event is triggered when a user attribute definition is created
user/user_attributes_definition/delete/v1
# This event is triggered when a user attribute definition is deleted
user/user_attributes_definition/update/v1
# This event is triggered when a user attribute definition is updated
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
object
Required
Properties
id
string
Required
This is the unique id of the attribute definition.
name
string
Required
Name of the user attribute.
slug
string
Required
A unique identifier for the user attribute definition.
description
string
Required
Description of the user attribute definition.
application_id
string
Required
Sales channel ID for which this user attribute definition is created
type
string
The type of the user attribute. Optional, defaults to string.
Enum
customer_editable
boolean
Indicates if the field is editable by the customer. Defaults to false.
encrypted
boolean
Indicates if the value should be encrypted. Defaults to false.
pinned
boolean
Indicates if this attribute is pinned for prominence. Defaults to false.
pin_order
number
The order in which the pinned attribute appears.
validations
array of object
Array of validations for this user attribute.
Array of Properties
type
string
The type of validation that should be done on value
Enum
value
array|string
The value(s) for which the validation should be applied
is_locked
boolean
Indicates if the attribute is locked from edits. Defaults to false.
created_by
string
Id of the user who created this attribute.
updated_by
string
Id of the user who last updated this attribute.
icon
string
Optional icon representation for this attribute. Defaults to an empty string.
ordering_channels
array of string
Ordering Channels where this attribute should be visible.
Enum
masking
object
This indicates the configuration of PII masking options
Properties
enabled
boolean
Indicates if PII masking is editable for this attribute.
type
string
Indicates the PII masking options available default or others
Enum
registration
object
This indicates the settings for customer registration
Properties
enabled
boolean
Indicates if an attribute is editable when customer registers for a storefront.
type
string
Indicates if this attribute is mandatory or optional when customer registers for a storefront.
Enum
is_multi_value
boolean
Indicates if this attribute can accept multiple values.
created_at
string
Timestamp of the attribute definition created in ISO format
modified_at
string
Timestamp of the attribute definition updated in ISO format
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": "object",76 "properties": {77 "id": {78 "type": "string",79 "description": "This is the unique id of the attribute definition."80 },81 "name": {82 "type": "string",83 "description": "Name of the user attribute."84 },85 "slug": {86 "type": "string",87 "description": "A unique identifier for the user attribute definition."88 },89 "description": {90 "type": "string",91 "description": "Description of the user attribute definition."92 },93 "application_id": {94 "type": "string",95 "description": "Sales channel ID for which this user attribute definition is created"96 },97 "type": {98 "type": "string",99 "enum": [100 "string",101 "string_array",102 "encrypted_string",103 "encrypted_string_array",104 "number",105 "number_array",106 "encrypted_number",107 "encrypted_number_array",108 "boolean",109 "encrypted_date",110 "date_time",111 "encrypted_date_time",112 "store_uid_array",113 "platform_user_array",114 "html_string",115 "image_url"116 ],117 "description": "The type of the user attribute. Optional, defaults to string."118 },119 "customer_editable": {120 "type": "boolean",121 "description": "Indicates if the field is editable by the customer. Defaults to false."122 },123 "encrypted": {124 "type": "boolean",125 "description": "Indicates if the value should be encrypted. Defaults to false."126 },127 "pinned": {128 "type": "boolean",129 "description": "Indicates if this attribute is pinned for prominence. Defaults to false."130 },131 "pin_order": {132 "type": "number",133 "description": "The order in which the pinned attribute appears."134 },135 "validations": {136 "type": "array",137 "items": {138 "type": "object",139 "properties": {140 "type": {141 "type": "string",142 "description": "The type of validation that should be done on value",143 "enum": [144 "min",145 "max",146 "regex"147 ]148 },149 "value": {150 "type": [151 "array",152 "string"153 ],154 "description": "The value(s) for which the validation should be applied"155 }156 }157 },158 "description": "Array of validations for this user attribute."159 },160 "is_locked": {161 "type": "boolean",162 "description": "Indicates if the attribute is locked from edits. Defaults to false."163 },164 "created_by": {165 "type": "string",166 "description": "Id of the user who created this attribute."167 },168 "updated_by": {169 "type": "string",170 "description": "Id of the user who last updated this attribute."171 },172 "icon": {173 "type": "string",174 "description": "Optional icon representation for this attribute. Defaults to an empty string."175 },176 "ordering_channels": {177 "type": "array",178 "items": {179 "type": "string",180 "enum": [181 "storefront",182 "store_os_pos",183 "kiosk",184 "scan_go",185 "gofynd",186 "smart_trolley",187 "uniket",188 "marketplace",189 "social_commerce",190 "ondc"191 ]192 },193 "description": "Ordering Channels where this attribute should be visible."194 },195 "masking": {196 "type": "object",197 "description": "This indicates the configuration of PII masking options",198 "properties": {199 "enabled": {200 "type": "boolean",201 "description": "Indicates if PII masking is editable for this attribute."202 },203 "type": {204 "type": "string",205 "description": "Indicates the PII masking options available default or others",206 "enum": [207 "default",208 "other"209 ]210 }211 }212 },213 "registration": {214 "type": "object",215 "description": "This indicates the settings for customer registration",216 "properties": {217 "enabled": {218 "type": "boolean",219 "description": "Indicates if an attribute is editable when customer registers for a storefront."220 },221 "type": {222 "type": "string",223 "description": "Indicates if this attribute is mandatory or optional when customer registers for a storefront.",224 "enum": [225 "mandatory",226 "optional"227 ]228 }229 }230 },231 "is_multi_value": {232 "type": "boolean",233 "description": "Indicates if this attribute can accept multiple values."234 },235 "created_at": {236 "type": "string",237 "description": "Timestamp of the attribute definition created in ISO format"238 },239 "modified_at": {240 "type": "string",241 "description": "Timestamp of the attribute definition updated in ISO format"242 }243 },244 "required": [245 "name",246 "slug",247 "description",248 "application_id",249 "id"250 ]251 }252 }253}
Payload Example
1{2 "event": {3 "trace_id": [4 "deadlock.2f918af5-87be-475d-9d43-db71691b85a9"5 ],6 "name": "user_attributes_definition",7 "type": "create",8 "version": "1",9 "created_timestamp": 1711535331878,10 "id": "2f918af5-87be-475d-9d43-db71691b85a9",11 "category": "application",12 "referer": "fyndx1.de"13 },14 "company_id": 1,15 "application_id": "64c00b72c07acacc1357503b",16 "contains": [17 "id",18 "name",19 "slug",20 "description",21 "application_id",22 "type",23 "customer_editable",24 "encrypted",25 "pinned",26 "pin_order",27 "validations",28 "is_locked",29 "created_by",30 "updated_by",31 "icon",32 "ordering_channels",33 "masking",34 "registration",35 "is_multi_value",36 "created_at",37 "modified_at"38 ],39 "payload": {40 "default_value": [],41 "options": [42 "Value 1",43 "Value 2"44 ],45 "name": "Dropdown Attribute",46 "slug": "dropdowntest",47 "description": "This is a Dropdown Attribute",48 "application_id": "681224c7070fc71550196839",49 "type": "dropdown",50 "customer_editable": true,51 "encrypted": true,52 "pinned": false,53 "is_locked": false,54 "created_by": "fb0d4a48a36af2404b46d292",55 "icon": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/subgroupsns/misc/pictures/free-icon/original/Fl6A26-8a-attribute-logo.png",56 "ordering_channels": [57 "scan_go",58 "store_os_pos"59 ],60 "masking": {61 "enabled": true,62 "type": "default"63 },64 "registration": {65 "enabled": true,66 "type": "mandatory"67 },68 "is_multi_value": true,69 "id": "682f26be51d1c5988e109a4d",70 "validations": [],71 "created_at": "2025-05-22T13:29:34.850Z",72 "modified_at": "2025-05-22T13:29:34.850Z"73 }74}
Was this section helpful?
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
object
Required
Properties
id
string
Required
This is the unique id of the attribute definition.
name
string
Required
Name of the user attribute.
slug
string
Required
A unique identifier for the user attribute definition.
description
string
Required
Description of the user attribute definition.
application_id
string
Required
Sales channel ID for which this user attribute definition is deleted
type
string
The type of the user attribute. Optional, defaults to string.
Enum
customer_editable
boolean
Indicates if the field is editable by the customer. Defaults to false.
encrypted
boolean
Indicates if the value should be encrypted. Defaults to false.
pinned
boolean
Indicates if this attribute is pinned for prominence. Defaults to false.
pin_order
number
The order in which the pinned attribute appears.
validations
array of object
Array of validations for this user attribute.
Array of Properties
type
string
The type of validation that should be done on value
Enum
value
array|string
The value(s) for which the validation should be applied
is_locked
boolean
Indicates if the attribute is locked from edits. Defaults to false.
created_by
string
Id of the user who created this attribute.
updated_by
string
Id of the user who last updated this attribute.
icon
string
Optional icon representation for this attribute. Defaults to an empty string.
ordering_channels
array of string
Ordering Channels where this attribute should be visible.
Enum
masking
object
This indicates the configuration of PII masking options
Properties
enabled
boolean
Indicates if PII masking is editable for this attribute.
type
string
Indicates the PII masking options available default or others
Enum
registration
object
This indicates the settings for customer registration
Properties
enabled
boolean
Indicates if an attribute is editable when customer registers for a storefront.
type
string
Indicates if this attribute is mandatory or optional when customer registers for a storefront.
Enum
is_multi_value
boolean
Indicates if this attribute can accept multiple values.
created_at
string
Timestamp of the attribute definition created in ISO format
modified_at
string
Timestamp of the attribute definition updated in ISO format
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": "object",76 "properties": {77 "id": {78 "type": "string",79 "description": "This is the unique id of the attribute definition."80 },81 "name": {82 "type": "string",83 "description": "Name of the user attribute."84 },85 "slug": {86 "type": "string",87 "description": "A unique identifier for the user attribute definition."88 },89 "description": {90 "type": "string",91 "description": "Description of the user attribute definition."92 },93 "application_id": {94 "type": "string",95 "description": "Sales channel ID for which this user attribute definition is deleted"96 },97 "type": {98 "type": "string",99 "enum": [100 "string",101 "string_array",102 "encrypted_string",103 "encrypted_string_array",104 "number",105 "number_array",106 "encrypted_number",107 "encrypted_number_array",108 "boolean",109 "encrypted_date",110 "date_time",111 "encrypted_date_time",112 "store_uid_array",113 "platform_user_array",114 "html_string",115 "image_url"116 ],117 "description": "The type of the user attribute. Optional, defaults to string."118 },119 "customer_editable": {120 "type": "boolean",121 "description": "Indicates if the field is editable by the customer. Defaults to false."122 },123 "encrypted": {124 "type": "boolean",125 "description": "Indicates if the value should be encrypted. Defaults to false."126 },127 "pinned": {128 "type": "boolean",129 "description": "Indicates if this attribute is pinned for prominence. Defaults to false."130 },131 "pin_order": {132 "type": "number",133 "description": "The order in which the pinned attribute appears."134 },135 "validations": {136 "type": "array",137 "items": {138 "type": "object",139 "properties": {140 "type": {141 "type": "string",142 "description": "The type of validation that should be done on value",143 "enum": [144 "min",145 "max",146 "regex"147 ]148 },149 "value": {150 "type": [151 "array",152 "string"153 ],154 "description": "The value(s) for which the validation should be applied"155 }156 }157 },158 "description": "Array of validations for this user attribute."159 },160 "is_locked": {161 "type": "boolean",162 "description": "Indicates if the attribute is locked from edits. Defaults to false."163 },164 "created_by": {165 "type": "string",166 "description": "Id of the user who created this attribute."167 },168 "updated_by": {169 "type": "string",170 "description": "Id of the user who last updated this attribute."171 },172 "icon": {173 "type": "string",174 "description": "Optional icon representation for this attribute. Defaults to an empty string."175 },176 "ordering_channels": {177 "type": "array",178 "items": {179 "type": "string",180 "enum": [181 "storefront",182 "store_os_pos",183 "kiosk",184 "scan_go",185 "gofynd",186 "smart_trolley",187 "uniket",188 "marketplace",189 "social_commerce",190 "ondc"191 ]192 },193 "description": "Ordering Channels where this attribute should be visible."194 },195 "masking": {196 "type": "object",197 "description": "This indicates the configuration of PII masking options",198 "properties": {199 "enabled": {200 "type": "boolean",201 "description": "Indicates if PII masking is editable for this attribute."202 },203 "type": {204 "type": "string",205 "description": "Indicates the PII masking options available default or others",206 "enum": [207 "default",208 "other"209 ]210 }211 }212 },213 "registration": {214 "type": "object",215 "description": "This indicates the settings for customer registration",216 "properties": {217 "enabled": {218 "type": "boolean",219 "description": "Indicates if an attribute is editable when customer registers for a storefront."220 },221 "type": {222 "type": "string",223 "description": "Indicates if this attribute is mandatory or optional when customer registers for a storefront.",224 "enum": [225 "mandatory",226 "optional"227 ]228 }229 }230 },231 "is_multi_value": {232 "type": "boolean",233 "description": "Indicates if this attribute can accept multiple values."234 },235 "created_at": {236 "type": "string",237 "description": "Timestamp of the attribute definition created in ISO format"238 },239 "modified_at": {240 "type": "string",241 "description": "Timestamp of the attribute definition updated in ISO format"242 }243 },244 "required": [245 "name",246 "slug",247 "description",248 "application_id",249 "id"250 ]251 }252 }253}
Payload Example
1{2 "event": {3 "trace_id": [4 "deadlock.2f918af5-87be-475d-9d43-db71691b85a9"5 ],6 "name": "user_attributes_definition",7 "type": "delete",8 "version": "1",9 "created_timestamp": 1711535331878,10 "id": "2f918af5-87be-475d-9d43-db71691b85a9",11 "category": "application",12 "referer": "fyndx1.de"13 },14 "company_id": 1,15 "application_id": "64c00b72c07acacc1357503b",16 "contains": [17 "id",18 "name",19 "slug",20 "description",21 "application_id",22 "type",23 "customer_editable",24 "encrypted",25 "pinned",26 "pin_order",27 "validations",28 "is_locked",29 "created_by",30 "updated_by",31 "icon",32 "ordering_channels",33 "masking",34 "registration",35 "is_multi_value",36 "created_at",37 "modified_at"38 ],39 "payload": {40 "default_value": [],41 "options": [42 "Value 1",43 "Value 2"44 ],45 "name": "Dropdown Attribute",46 "slug": "dropdowntest",47 "description": "This is a Dropdown Attribute",48 "application_id": "681224c7070fc71550196839",49 "type": "dropdown",50 "customer_editable": true,51 "encrypted": true,52 "pinned": false,53 "is_locked": false,54 "created_by": "fb0d4a48a36af2404b46d292",55 "icon": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/subgroupsns/misc/pictures/free-icon/original/Fl6A26-8a-attribute-logo.png",56 "ordering_channels": [57 "scan_go",58 "store_os_pos"59 ],60 "masking": {61 "enabled": true,62 "type": "default"63 },64 "registration": {65 "enabled": true,66 "type": "mandatory"67 },68 "is_multi_value": true,69 "id": "682f26be51d1c5988e109a4d",70 "validations": [],71 "created_at": "2025-05-22T13:29:34.850Z",72 "modified_at": "2025-05-22T13:29:34.850Z"73 }74}
Was this section helpful?
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
object
Required
Properties
id
string
Required
This is the unique id of the attribute definition.
name
string
Required
Name of the user attribute.
slug
string
Required
A unique identifier for the user attribute definition.
description
string
Required
Description of the user attribute definition.
application_id
string
Required
Sales channel ID for which this user attribute definition is updated
type
string
The type of the user attribute. Optional, defaults to string.
Enum
customer_editable
boolean
Indicates if the field is editable by the customer. Defaults to false.
encrypted
boolean
Indicates if the value should be encrypted. Defaults to false.
pinned
boolean
Indicates if this attribute is pinned for prominence. Defaults to false.
pin_order
number
The order in which the pinned attribute appears.
validations
array of object
Array of validations for this user attribute.
Array of Properties
type
string
The type of validation that should be done on value
Enum
value
array|string
The value(s) for which the validation should be applied
is_locked
boolean
Indicates if the attribute is locked from edits. Defaults to false.
created_by
string
Id of the user who created this attribute.
updated_by
string
Id of the user who last updated this attribute.
icon
string
Optional icon representation for this attribute. Defaults to an empty string.
ordering_channels
array of string
Ordering Channels where this attribute should be visible.
Enum
masking
object
This indicates the configuration of PII masking options
Properties
enabled
boolean
Indicates if PII masking is editable for this attribute.
type
string
Indicates the PII masking options available default or others
Enum
registration
object
This indicates the settings for customer registration
Properties
enabled
boolean
Indicates if an attribute is editable when customer registers for a storefront.
type
string
Indicates if this attribute is mandatory or optional when customer registers for a storefront.
Enum
is_multi_value
boolean
Indicates if this attribute can accept multiple values.
created_at
string
Timestamp of the attribute definition created in ISO format
modified_at
string
Timestamp of the attribute definition updated in ISO format
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": "object",76 "properties": {77 "id": {78 "type": "string",79 "description": "This is the unique id of the attribute definition."80 },81 "name": {82 "type": "string",83 "description": "Name of the user attribute."84 },85 "slug": {86 "type": "string",87 "description": "A unique identifier for the user attribute definition."88 },89 "description": {90 "type": "string",91 "description": "Description of the user attribute definition."92 },93 "application_id": {94 "type": "string",95 "description": "Sales channel ID for which this user attribute definition is updated"96 },97 "type": {98 "type": "string",99 "enum": [100 "string",101 "string_array",102 "encrypted_string",103 "encrypted_string_array",104 "number",105 "number_array",106 "encrypted_number",107 "encrypted_number_array",108 "boolean",109 "encrypted_date",110 "date_time",111 "encrypted_date_time",112 "store_uid_array",113 "platform_user_array",114 "html_string",115 "image_url"116 ],117 "description": "The type of the user attribute. Optional, defaults to string."118 },119 "customer_editable": {120 "type": "boolean",121 "description": "Indicates if the field is editable by the customer. Defaults to false."122 },123 "encrypted": {124 "type": "boolean",125 "description": "Indicates if the value should be encrypted. Defaults to false."126 },127 "pinned": {128 "type": "boolean",129 "description": "Indicates if this attribute is pinned for prominence. Defaults to false."130 },131 "pin_order": {132 "type": "number",133 "description": "The order in which the pinned attribute appears."134 },135 "validations": {136 "type": "array",137 "items": {138 "type": "object",139 "properties": {140 "type": {141 "type": "string",142 "description": "The type of validation that should be done on value",143 "enum": [144 "min",145 "max",146 "regex"147 ]148 },149 "value": {150 "type": [151 "array",152 "string"153 ],154 "description": "The value(s) for which the validation should be applied"155 }156 }157 },158 "description": "Array of validations for this user attribute."159 },160 "is_locked": {161 "type": "boolean",162 "description": "Indicates if the attribute is locked from edits. Defaults to false."163 },164 "created_by": {165 "type": "string",166 "description": "Id of the user who created this attribute."167 },168 "updated_by": {169 "type": "string",170 "description": "Id of the user who last updated this attribute."171 },172 "icon": {173 "type": "string",174 "description": "Optional icon representation for this attribute. Defaults to an empty string."175 },176 "ordering_channels": {177 "type": "array",178 "items": {179 "type": "string",180 "enum": [181 "storefront",182 "store_os_pos",183 "kiosk",184 "scan_go",185 "gofynd",186 "smart_trolley",187 "uniket",188 "marketplace",189 "social_commerce",190 "ondc"191 ]192 },193 "description": "Ordering Channels where this attribute should be visible."194 },195 "masking": {196 "type": "object",197 "description": "This indicates the configuration of PII masking options",198 "properties": {199 "enabled": {200 "type": "boolean",201 "description": "Indicates if PII masking is editable for this attribute."202 },203 "type": {204 "type": "string",205 "description": "Indicates the PII masking options available default or others",206 "enum": [207 "default",208 "other"209 ]210 }211 }212 },213 "registration": {214 "type": "object",215 "description": "This indicates the settings for customer registration",216 "properties": {217 "enabled": {218 "type": "boolean",219 "description": "Indicates if an attribute is editable when customer registers for a storefront."220 },221 "type": {222 "type": "string",223 "description": "Indicates if this attribute is mandatory or optional when customer registers for a storefront.",224 "enum": [225 "mandatory",226 "optional"227 ]228 }229 }230 },231 "is_multi_value": {232 "type": "boolean",233 "description": "Indicates if this attribute can accept multiple values."234 },235 "created_at": {236 "type": "string",237 "description": "Timestamp of the attribute definition created in ISO format"238 },239 "modified_at": {240 "type": "string",241 "description": "Timestamp of the attribute definition updated in ISO format"242 }243 },244 "required": [245 "name",246 "slug",247 "description",248 "application_id",249 "id"250 ]251 }252 }253}
Payload Example
1{2 "event": {3 "trace_id": [4 "deadlock.2f918af5-87be-475d-9d43-db71691b85a9"5 ],6 "name": "user_attributes_definition",7 "type": "update",8 "version": "1",9 "created_timestamp": 1711535331878,10 "id": "2f918af5-87be-475d-9d43-db71691b85a9",11 "category": "application",12 "referer": "fyndx1.de"13 },14 "company_id": 1,15 "application_id": "64c00b72c07acacc1357503b",16 "contains": [17 "id",18 "name",19 "slug",20 "description",21 "application_id",22 "type",23 "customer_editable",24 "encrypted",25 "pinned",26 "pin_order",27 "validations",28 "is_locked",29 "created_by",30 "updated_by",31 "icon",32 "ordering_channels",33 "masking",34 "registration",35 "is_multi_value",36 "created_at",37 "modified_at"38 ],39 "payload": {40 "default_value": [],41 "options": [42 "Value 1",43 "Value 2"44 ],45 "name": "Dropdown Attribute",46 "slug": "dropdowntest",47 "description": "This is a Dropdown Attribute",48 "application_id": "681224c7070fc71550196839",49 "type": "dropdown",50 "customer_editable": true,51 "encrypted": true,52 "pinned": false,53 "is_locked": false,54 "created_by": "fb0d4a48a36af2404b46d292",55 "icon": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/subgroupsns/misc/pictures/free-icon/original/Fl6A26-8a-attribute-logo.png",56 "ordering_channels": [57 "scan_go",58 "store_os_pos"59 ],60 "masking": {61 "enabled": true,62 "type": "default"63 },64 "registration": {65 "enabled": true,66 "type": "mandatory"67 },68 "is_multi_value": true,69 "id": "682f26be51d1c5988e109a4d",70 "validations": [],71 "created_at": "2025-05-22T13:29:34.850Z",72 "modified_at": "2025-05-22T13:29:34.850Z"73 }74}
Was this section helpful?