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.
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
application/user_attributes_definition/create/v1
# Triggered when a user attribute definition is created
application/user_attributes_definition/update/v1
# Triggered when a user attribute definition is updated
application/user_attributes_definition/delete/v1
# Triggered when a user attribute definition is deleted
Payload
Hide
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
Show
payload
object
Required
Show
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": "Indicates whether the event category 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 verify whether the event has already been processed by the 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_boolean",110 "dropdown",111 "encrypted_dropdown",112 "date",113 "encrypted_date",114 "date_time",115 "encrypted_date_time",116 "store_uid_array",117 "platform_user_array",118 "html_string",119 "image_url"120 ],121 "description": "The type of the user attribute. Optional, defaults to string."122 },123 "customer_editable": {124 "type": "boolean",125 "description": "Indicates if the field is editable by the customer. Defaults to false."126 },127 "encrypted": {128 "type": "boolean",129 "description": "Indicates if the value should be encrypted. Defaults to false."130 },131 "pinned": {132 "type": "boolean",133 "description": "Indicates if this attribute is pinned for prominence. Defaults to false."134 },135 "pin_order": {136 "type": "number",137 "description": "The order in which the pinned attribute appears."138 },139 "validations": {140 "type": "array",141 "items": {142 "type": "object",143 "properties": {144 "type": {145 "type": "string",146 "description": "The type of validation that should be done on value",147 "enum": [148 "min",149 "max",150 "regex"151 ]152 },153 "value": {154 "type": [155 "array",156 "string"157 ],158 "description": "The value(s) for which the validation should be applied"159 }160 }161 },162 "description": "Array of validations for this user attribute."163 },164 "is_locked": {165 "type": "boolean",166 "description": "Indicates if the attribute is locked from edits. Defaults to false."167 },168 "created_by": {169 "type": "string",170 "description": "Id of the user who created this attribute."171 },172 "updated_by": {173 "type": "string",174 "description": "Id of the user who last updated this attribute."175 },176 "icon": {177 "type": "string",178 "description": "Optional icon representation for this attribute. Defaults to an empty string."179 },180 "ordering_channels": {181 "type": "array",182 "items": {183 "type": "string",184 "enum": [185 "storefront",186 "store_os_pos",187 "kiosk",188 "scan_go",189 "gofynd",190 "smart_trolley",191 "uniket",192 "marketplace",193 "social_commerce",194 "ondc"195 ]196 },197 "description": "Sales channels where this attribute should be visible during ordering."198 },199 "masking": {200 "type": "object",201 "description": "Configuration for PII masking options on this attribute.",202 "properties": {203 "enabled": {204 "type": "boolean",205 "description": "Indicates if PII masking is editable for this attribute."206 },207 "type": {208 "type": "string",209 "description": "Indicates which PII masking option is applied: 'default' or 'other'.",210 "enum": [211 "default",212 "other"213 ]214 }215 }216 },217 "registration": {218 "type": "object",219 "description": "Configuration for how this attribute behaves during customer registration.",220 "properties": {221 "enabled": {222 "type": "boolean",223 "description": "Indicates if an attribute is editable when customer registers for a storefront."224 },225 "type": {226 "type": "string",227 "description": "Indicates if this attribute is mandatory or optional when customer registers for a storefront.",228 "enum": [229 "mandatory",230 "optional"231 ]232 }233 }234 },235 "is_multi_value": {236 "type": "boolean",237 "description": "Indicates if this attribute can accept multiple values."238 },239 "created_at": {240 "type": "string",241 "description": "Timestamp of when the attribute definition was created, in ISO format."242 },243 "modified_at": {244 "type": "string",245 "description": "Timestamp of when the attribute definition was last updated, in ISO format."246 }247 },248 "required": [249 "name",250 "slug",251 "description",252 "application_id",253 "id"254 ]255 }256 }257}
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}
Payload
Hide
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
Show
payload
object
Required
Show
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": "Indicates whether the event category 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 verify whether the event has already been processed by the 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_boolean",110 "dropdown",111 "encrypted_dropdown",112 "date",113 "encrypted_date",114 "date_time",115 "encrypted_date_time",116 "store_uid_array",117 "platform_user_array",118 "html_string",119 "image_url"120 ],121 "description": "The type of the user attribute. Optional, defaults to string."122 },123 "customer_editable": {124 "type": "boolean",125 "description": "Indicates if the field is editable by the customer. Defaults to false."126 },127 "encrypted": {128 "type": "boolean",129 "description": "Indicates if the value should be encrypted. Defaults to false."130 },131 "pinned": {132 "type": "boolean",133 "description": "Indicates if this attribute is pinned for prominence. Defaults to false."134 },135 "pin_order": {136 "type": "number",137 "description": "The order in which the pinned attribute appears."138 },139 "validations": {140 "type": "array",141 "items": {142 "type": "object",143 "properties": {144 "type": {145 "type": "string",146 "description": "The type of validation that should be done on value",147 "enum": [148 "min",149 "max",150 "regex"151 ]152 },153 "value": {154 "type": [155 "array",156 "string"157 ],158 "description": "The value(s) for which the validation should be applied"159 }160 }161 },162 "description": "Array of validations for this user attribute."163 },164 "is_locked": {165 "type": "boolean",166 "description": "Indicates if the attribute is locked from edits. Defaults to false."167 },168 "created_by": {169 "type": "string",170 "description": "Id of the user who created this attribute."171 },172 "updated_by": {173 "type": "string",174 "description": "Id of the user who last updated this attribute."175 },176 "icon": {177 "type": "string",178 "description": "Optional icon representation for this attribute. Defaults to an empty string."179 },180 "ordering_channels": {181 "type": "array",182 "items": {183 "type": "string",184 "enum": [185 "storefront",186 "store_os_pos",187 "kiosk",188 "scan_go",189 "gofynd",190 "smart_trolley",191 "uniket",192 "marketplace",193 "social_commerce",194 "ondc"195 ]196 },197 "description": "Sales channels where this attribute should be visible during ordering."198 },199 "masking": {200 "type": "object",201 "description": "Configuration for PII masking options on this attribute.",202 "properties": {203 "enabled": {204 "type": "boolean",205 "description": "Indicates if PII masking is editable for this attribute."206 },207 "type": {208 "type": "string",209 "description": "Indicates which PII masking option is applied: 'default' or 'other'.",210 "enum": [211 "default",212 "other"213 ]214 }215 }216 },217 "registration": {218 "type": "object",219 "description": "Configuration for how this attribute behaves during customer registration.",220 "properties": {221 "enabled": {222 "type": "boolean",223 "description": "Indicates if an attribute is editable when customer registers for a storefront."224 },225 "type": {226 "type": "string",227 "description": "Indicates if this attribute is mandatory or optional when customer registers for a storefront.",228 "enum": [229 "mandatory",230 "optional"231 ]232 }233 }234 },235 "is_multi_value": {236 "type": "boolean",237 "description": "Indicates if this attribute can accept multiple values."238 },239 "created_at": {240 "type": "string",241 "description": "Timestamp of when the attribute definition was created, in ISO format."242 },243 "modified_at": {244 "type": "string",245 "description": "Timestamp of when the attribute definition was last updated, in ISO format."246 }247 },248 "required": [249 "name",250 "slug",251 "description",252 "application_id",253 "id"254 ]255 }256 }257}
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}
Payload
Hide
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
Show
payload
object
Required
Show
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": "Indicates whether the event category 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 verify whether the event has already been processed by the 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_boolean",110 "dropdown",111 "encrypted_dropdown",112 "date",113 "encrypted_date",114 "date_time",115 "encrypted_date_time",116 "store_uid_array",117 "platform_user_array",118 "html_string",119 "image_url"120 ],121 "description": "The type of the user attribute. Optional, defaults to string."122 },123 "customer_editable": {124 "type": "boolean",125 "description": "Indicates if the field is editable by the customer. Defaults to false."126 },127 "encrypted": {128 "type": "boolean",129 "description": "Indicates if the value should be encrypted. Defaults to false."130 },131 "pinned": {132 "type": "boolean",133 "description": "Indicates if this attribute is pinned for prominence. Defaults to false."134 },135 "pin_order": {136 "type": "number",137 "description": "The order in which the pinned attribute appears."138 },139 "validations": {140 "type": "array",141 "items": {142 "type": "object",143 "properties": {144 "type": {145 "type": "string",146 "description": "The type of validation that should be done on value",147 "enum": [148 "min",149 "max",150 "regex"151 ]152 },153 "value": {154 "type": [155 "array",156 "string"157 ],158 "description": "The value(s) for which the validation should be applied"159 }160 }161 },162 "description": "Array of validations for this user attribute."163 },164 "is_locked": {165 "type": "boolean",166 "description": "Indicates if the attribute is locked from edits. Defaults to false."167 },168 "created_by": {169 "type": "string",170 "description": "Id of the user who created this attribute."171 },172 "updated_by": {173 "type": "string",174 "description": "Id of the user who last updated this attribute."175 },176 "icon": {177 "type": "string",178 "description": "Optional icon representation for this attribute. Defaults to an empty string."179 },180 "ordering_channels": {181 "type": "array",182 "items": {183 "type": "string",184 "enum": [185 "storefront",186 "store_os_pos",187 "kiosk",188 "scan_go",189 "gofynd",190 "smart_trolley",191 "uniket",192 "marketplace",193 "social_commerce",194 "ondc"195 ]196 },197 "description": "Sales channels where this attribute should be visible during ordering."198 },199 "masking": {200 "type": "object",201 "description": "Configuration for PII masking options on this attribute.",202 "properties": {203 "enabled": {204 "type": "boolean",205 "description": "Indicates if PII masking is editable for this attribute."206 },207 "type": {208 "type": "string",209 "description": "Indicates which PII masking option is applied: 'default' or 'other'.",210 "enum": [211 "default",212 "other"213 ]214 }215 }216 },217 "registration": {218 "type": "object",219 "description": "Configuration for how this attribute behaves during customer registration.",220 "properties": {221 "enabled": {222 "type": "boolean",223 "description": "Indicates if an attribute is editable when customer registers for a storefront."224 },225 "type": {226 "type": "string",227 "description": "Indicates if this attribute is mandatory or optional when customer registers for a storefront.",228 "enum": [229 "mandatory",230 "optional"231 ]232 }233 }234 },235 "is_multi_value": {236 "type": "boolean",237 "description": "Indicates if this attribute can accept multiple values."238 },239 "created_at": {240 "type": "string",241 "description": "Timestamp of when the attribute definition was created, in ISO format."242 },243 "modified_at": {244 "type": "string",245 "description": "Timestamp of when the attribute definition was last updated, in ISO format."246 }247 },248 "required": [249 "name",250 "slug",251 "description",252 "application_id",253 "id"254 ]255 }256 }257}
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}