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.

User attributes

This event is generated when a user's attribute value is created, updated, or deleted.

Events

application/user_attributes/create/v1

# Triggered when a user attribute value is created

application/user_attributes/update/v1

# Triggered when a user attribute value is updated

application/user_attributes/delete/v1

# Triggered when a user attribute value is deleted

User Attributes/user_attributes/create/v1

Triggered when a user attribute value is created

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 lists all the keys present in each object within the 'payload' array.

event

object

Required

Show

payload

array of 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 lists all the keys present in each object within the 'payload' array.",
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": "array",
76      "items": {
77        "type": "object",
78        "properties": {
79          "id": {
80            "type": "string",
81            "description": "Uniquely generated ID of this user attribute value record."
82          },
83          "type": {
84            "type": "string",
85            "description": "The type of the user attribute (see enum values).",
86            "enum": [
87              "string",
88              "string_array",
89              "encrypted_string",
90              "encrypted_string_array",
91              "number",
92              "number_array",
93              "encrypted_number",
94              "encrypted_number_array",
95              "boolean",
96              "encrypted_boolean",
97              "dropdown",
98              "encrypted_dropdown",
99              "date",
100              "encrypted_date",
101              "date_time",
102              "encrypted_date_time",
103              "store_uid_array",
104              "platform_user_array",
105              "html_string",
106              "image_url"
107            ]
108          },
109          "application_id": {
110            "type": "string",
111            "description": "Application ID (sales channel) where this user attribute value was created."
112          },
113          "attribute": {
114            "type": "object",
115            "properties": {
116              "key": {
117                "type": "string",
118                "description": "Key identifying the user attribute."
119              },
120              "value": {
121                "type": [
122                  "array",
123                  "string",
124                  "boolean",
125                  "integer"
126                ],
127                "description": "Value of the user attribute — a single string, number, or boolean for single-value attributes, or an array for multi-value attributes."
128              }
129            }
130          },
131          "created_at": {
132            "type": "string",
133            "description": "Timestamp of when the user attribute value was created, in ISO format."
134          },
135          "modified_at": {
136            "type": "string",
137            "description": "Timestamp of when the user attribute value was last updated, in ISO format."
138          },
139          "customer_overridden": {
140            "type": "boolean",
141            "description": "Indicates if the user attribute value is customer overridden"
142          },
143          "name": {
144            "type": "string",
145            "description": "Name of the user attribute"
146          },
147          "updated_by": {
148            "type": "string",
149            "description": "User ID of the user who updated the user attribute value"
150          },
151          "user_attribute_definition_id": {
152            "type": "string",
153            "description": "ID of the user attribute definition this value is associated with."
154          },
155          "user_id": {
156            "type": "string",
157            "description": "ID of the user whose attribute value was created or updated."
158          }
159        },
160        "required": [
161          "id",
162          "type",
163          "name",
164          "application_id",
165          "attribute",
166          "user_attribute_definition_id"
167        ]
168      }
169    }
170  }
171}

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}

User Attributes/user_attributes/update/v1

Triggered when a user attribute value is updated

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 lists all the keys present in each object within the 'payload' array.

event

object

Required

Show

payload

array of 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 lists all the keys present in each object within the 'payload' array.",
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": "array",
76      "items": {
77        "type": "object",
78        "properties": {
79          "id": {
80            "type": "string",
81            "description": "Uniquely generated ID of this user attribute value record."
82          },
83          "type": {
84            "type": "string",
85            "description": "The type of the user attribute (see enum values).",
86            "enum": [
87              "string",
88              "string_array",
89              "encrypted_string",
90              "encrypted_string_array",
91              "number",
92              "number_array",
93              "encrypted_number",
94              "encrypted_number_array",
95              "boolean",
96              "encrypted_boolean",
97              "dropdown",
98              "encrypted_dropdown",
99              "date",
100              "encrypted_date",
101              "date_time",
102              "encrypted_date_time",
103              "store_uid_array",
104              "platform_user_array",
105              "html_string",
106              "image_url"
107            ]
108          },
109          "application_id": {
110            "type": "string",
111            "description": "Application ID (sales channel) where this user attribute value was created."
112          },
113          "attribute": {
114            "type": "object",
115            "properties": {
116              "key": {
117                "type": "string",
118                "description": "Key identifying the user attribute."
119              },
120              "value": {
121                "type": [
122                  "array",
123                  "string",
124                  "boolean",
125                  "integer"
126                ],
127                "description": "Value of the user attribute — a single string, number, or boolean for single-value attributes, or an array for multi-value attributes."
128              }
129            }
130          },
131          "created_at": {
132            "type": "string",
133            "description": "Timestamp of when the user attribute value was created, in ISO format."
134          },
135          "modified_at": {
136            "type": "string",
137            "description": "Timestamp of when the user attribute value was last updated, in ISO format."
138          },
139          "customer_overridden": {
140            "type": "boolean",
141            "description": "Indicates if the user attribute value is customer overridden"
142          },
143          "name": {
144            "type": "string",
145            "description": "Name of the user attribute"
146          },
147          "updated_by": {
148            "type": "string",
149            "description": "User ID of the user who updated the user attribute value"
150          },
151          "user_attribute_definition_id": {
152            "type": "string",
153            "description": "ID of the user attribute definition this value is associated with."
154          },
155          "user_id": {
156            "type": "string",
157            "description": "ID of the user whose attribute value was created or updated."
158          }
159        },
160        "required": [
161          "id",
162          "type",
163          "name",
164          "application_id",
165          "attribute",
166          "user_attribute_definition_id"
167        ]
168      }
169    }
170  }
171}

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}

User Attributes/user_attributes/delete/v1

Triggered when a user attribute value 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 lists all the keys present in each object within the 'payload' array.

event

object

Required

Show

payload

array of 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 lists all the keys present in each object within the 'payload' array.",
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": "array",
76      "items": {
77        "type": "object",
78        "properties": {
79          "id": {
80            "type": "string",
81            "description": "Uniquely generated ID of this user attribute value record."
82          },
83          "type": {
84            "type": "string",
85            "description": "The type of the user attribute (see enum values).",
86            "enum": [
87              "string",
88              "string_array",
89              "encrypted_string",
90              "encrypted_string_array",
91              "number",
92              "number_array",
93              "encrypted_number",
94              "encrypted_number_array",
95              "boolean",
96              "encrypted_boolean",
97              "dropdown",
98              "encrypted_dropdown",
99              "date",
100              "encrypted_date",
101              "date_time",
102              "encrypted_date_time",
103              "store_uid_array",
104              "platform_user_array",
105              "html_string",
106              "image_url"
107            ]
108          },
109          "application_id": {
110            "type": "string",
111            "description": "Application ID (sales channel) where this user attribute value was deleted."
112          },
113          "attribute": {
114            "type": "object",
115            "properties": {
116              "key": {
117                "type": "string",
118                "description": "Key identifying the user attribute."
119              },
120              "value": {
121                "type": [
122                  "array",
123                  "string",
124                  "boolean",
125                  "integer"
126                ],
127                "description": "Value of the user attribute — a single string, number, or boolean for single-value attributes, or an array for multi-value attributes."
128              }
129            }
130          },
131          "created_at": {
132            "type": "string",
133            "description": "Timestamp of when the user attribute value was created, in ISO format."
134          },
135          "modified_at": {
136            "type": "string",
137            "description": "Timestamp of when the user attribute value was last updated, in ISO format."
138          },
139          "customer_overridden": {
140            "type": "boolean",
141            "description": "Indicates if the user attribute value is customer overridden"
142          },
143          "name": {
144            "type": "string",
145            "description": "Name of the user attribute"
146          },
147          "updated_by": {
148            "type": "string",
149            "description": "User ID of the user who updated the user attribute value"
150          },
151          "user_attribute_definition_id": {
152            "type": "string",
153            "description": "ID of the user attribute definition this value is associated with."
154          },
155          "user_id": {
156            "type": "string",
157            "description": "ID of the user whose attribute value was deleted."
158          }
159        },
160        "required": [
161          "id",
162          "type",
163          "name",
164          "application_id",
165          "user_attribute_definition_id"
166        ]
167      }
168    }
169  }
170}

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}

« user/create/v1

user_attributes_definition/create/v1 »