Webhooks
Overview
Webhook Configuration
Filters and Reducer
Best Practices
Kafka
Amazon EventBridge
Amazon SQS
Google Pub/Sub
Temporal
Change Log
article/create/v1
article/update/v1
article/delete/v1
brand/create/v1
brand/update/v1
company/create/v2
company/update/v2
company/delete/v2
courier-partner/account-status/v1
customfield_definition/create/v1
customfield_definition/update/v1
customfield_definition/delete/v1
customfields/inventory-update/v1
customfields/inventory-delete/v1
customfields/product-update/v1
customfields/product-delete/v1
customfields/product-size-update/v1
customfields/product-size-delete/v1
customfields/selling-location-update/v1
customobject_definition/create/v1
customobject_definition/update/v1
customobject_definition/delete/v1
customobjects/create/v1
customobjects/update/v1
customobjects/delete/v1
location/create/v2
location/update/v2
location-price/create/v1
location-price/update/v1
location-price/delete/v1
location-quantity/create/v1
location-quantity/update/v1
logistics-configuration/update/v1
product/create/v3
product/update/v3
product/delete/v3
product-size/create/v2
product-size/delete/v2
product-size/update/v2
support-ticket/create/v1
support-ticket/update/v1
address/create/v1
address/update/v1
address/delete/v1
article/create/v1
article/update/v1
article/delete/v1
available_pages/create/v1
available_pages/update/v1
available_pages/delete/v1
cart/create/v1
cart/update/v1
cart-price-adjustment/create/v1
cart-price-adjustment/update/v1
cart-price-adjustment/remove/v1
collection/create/v2
collection/update/v2
collection/delete/v2
configuration/create/v1
configuration/update/v1
coupon/create/v1
coupon/update/v1
coupon/redeem/v1
courier-partner/assign/v1
courier-partner/ndr/v1
courier-partner/cancel/v1
customer_credit_note_configuration/create/v1
customer_credit_note_configuration/update/v1
customfield_definition/create/v1
customfield_definition/update/v1
customfield_definition/delete/v1
customfields/bag-update/v1
customfields/coupon-update/v1
customfields/product-update/v1
customfields/promotion-update/v1
customobject_definition/create/v1
customobject_definition/update/v1
customobject_definition/delete/v1
customobjects/create/v1
customobjects/update/v1
customobjects/delete/v1
details_groups/create/v1
details_groups/update/v1
details_groups/delete/v1
discount/create/v1
discount/update/v1
discount/start/v1
discount/end/v1
domain/create/v1
domain/delete/v1
faq/create/v1
faq/update/v1
faq/delete/v1
filter/create/v1
filter/update/v1
filter/delete/v1
legal/update/v1
location-price/create/v1
location-price/update/v1
location-price/delete/v1
location-quantity/create/v1
location-quantity/update/v1
merchandising/create/v1
merchandising/update/v1
merchandising/delete/v1
offer/create/v1
offer/update/v1
offer/redeem/v1
order/placed/v1
order/pending/v1
order/payment_failed/v1
payment/complete/v1
payment/pending/v1
payment/failed/v1
product/create/v2
product/update/v2
product/delete/v2
product-price/create/v1
product-price/update/v1
product-price/delete/v1
promotion/create/v1
promotion/update/v1
promotion_usage/update/v1
refund/refund_initiated/v1
refund/refund_pending/v1
refund/refund_done/v1
refund/refund_failed/v1
return_config/update/v1
return_config_categories/update/v1
return_config_categories/delete/v1
rma_rule/create/v2
rma_rule/update/v2
rma_rule/create/v1
rma_rule/update/v1
seo/update/v1
shipment/create/v1
shipment/update/v1
shipment/data_update/v1
sort/create/v1
sort/update/v1
sort/delete/v1
tags/create/v1
tags/update/v1
tags/delete/v1
theme/create/v1
theme/update/v1
theme/delete/v1
user/create/v1
user/update/v1
user/delete/v1
variant/create/v1
variant/update/v1
variant/delete/v1
zone/create/v1
zone/update/v1
category/create/v1
category/update/v1
department/create/v1
department/update/v1
extension/install/v1
extension/uninstall/v1
extension-subscription/create/v1
extension-subscription/update/v1

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.

Address

This event will be generated where there is any action done on address

Events
application/address/create/v1
# this event is triggered when address is created
application/address/update/v1
# this event is triggered when address is updated
application/address/delete/v1
# this event is triggered when address is deleted

Address/address/create/v1

this event is triggered when address is created

Payload
Hide
application_id
array|string
Required
Application/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": "Application/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      "required": [
77        "address"
78      ],
79      "properties": {
80        "address": {
81          "type": "object",
82          "required": [
83            "area_code_slug",
84            "country_code",
85            "name",
86            "tags",
87            "expire_at",
88            "address",
89            "phone",
90            "_custom_json",
91            "checkout_mode",
92            "app_id",
93            "uid",
94            "state",
95            "is_default_address",
96            "_id",
97            "city",
98            "country",
99            "user_id",
100            "area_code"
101          ],
102          "properties": {
103            "_id": {
104              "type": "string",
105              "description": "Unique identifier for the address mongo object."
106            },
107            "uid": {
108              "type": "integer",
109              "description": "Unique identifier of the address object."
110            },
111            "area": {
112              "type": "string",
113              "description": "Building Name/ Street*."
114            },
115            "city": {
116              "type": "string",
117              "description": "City name."
118            },
119            "name": {
120              "type": "string",
121              "description": "Name of the user."
122            },
123            "tags": {
124              "type": "array",
125              "description": "Value to add to identify a group of address.",
126              "items": {
127                "type": "string"
128              }
129            },
130            "email": {
131              "type": [
132                "null",
133                "string"
134              ],
135              "description": "Email id of user."
136            },
137            "phone": {
138              "type": "integer",
139              "description": "Phone number of user."
140            },
141            "state": {
142              "type": "string",
143              "description": "State name."
144            },
145            "app_id": {
146              "type": "string",
147              "description": "Application id."
148            },
149            "address": {
150              "type": "string",
151              "description": "Flat No/House No/Building No."
152            },
153            "country": {
154              "type": "string",
155              "description": "Country name."
156            },
157            "user_id": {
158              "type": "string",
159              "description": "User Id of the user."
160            },
161            "landmark": {
162              "type": "string",
163              "description": "Landmark."
164            },
165            "area_code": {
166              "type": "string",
167              "description": "pincode or zipcode.."
168            },
169            "expire_at": {
170              "type": [
171                "null",
172                "string"
173              ],
174              "description": "Expiry for address."
175            },
176            "_custom_json": {
177              "type": "object",
178              "description": "Custom data for address/user."
179            },
180            "address_type": {
181              "type": "string",
182              "description": "This would represent the name of the address."
183            },
184            "country_code": {
185              "type": "string",
186              "description": "Country code."
187            },
188            "geo_location": {
189              "type": "object",
190              "required": [
191                "latitude",
192                "longitude"
193              ],
194              "properties": {
195                "latitude": {
196                  "type": "number"
197                },
198                "longitude": {
199                  "type": "number"
200                }
201              },
202              "description": "Geographic location e.g. latitude/longitude."
203            },
204            "checkout_mode": {
205              "type": "string",
206              "description": "Checkout type of user."
207            },
208            "area_code_slug": {
209              "type": "string",
210              "description": "Slug for area code e.g. pincode or zipcode."
211            },
212            "sector": {
213              "type": "string",
214              "description": "Sector will represent the sector for that address."
215            },
216            "state_code": {
217              "type": "string",
218              "description": "Sector will represent the code for that state."
219            },
220            "is_default_address": {
221              "type": "boolean",
222              "description": "Boolean for default address of user."
223            }
224          }
225        }
226      }
227    }
228  }
229}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "megatron.c9828f42-f16f-467a-88ae-4cf0fa0afd84"
5    ],
6    "name": "address",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712210270722,
10    "id": "e9pQKO0id7YvJEwIba0Ji0la4tOr4FA4fJqzX8YZYCQ=",
11    "category": "application"
12  },
13  "company_id": 292,
14  "application_id": "628f081195f552f12185aab5",
15  "contains": [
16    "address"
17  ],
18  "payload": {
19    "address": {
20      "landmark": "dummy landmark ",
21      "tags": [],
22      "phone": 1111111111,
23      "area": "dummy area ",
24      "expire_at": null,
25      "area_code_slug": "pincode",
26      "_id": "660e415ef015dbfce2469b25",
27      "user_id": "63f5d19be6acf23c4f0f0529",
28      "address": "test test ",
29      "country": "India",
30      "uid": 5787855,
31      "app_id": "628f081195f552f12185aab5",
32      "area_code": "560047",
33      "is_default_address": true,
34      "state": "Karnataka",
35      "sector": "",
36      "city": "Bangalore",
37      "state_code": "",
38      "address_type": "home",
39      "_custom_json": {},
40      "name": "dummy",
41      "email": "test@example.com",
42      "checkout_mode": "other",
43      "country_code": "null"
44    }
45  }
46}

Address/address/update/v1

this event is triggered when address is updated

Payload
Hide
application_id
array|string
Required
Application/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": "Application/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      "required": [
77        "address"
78      ],
79      "properties": {
80        "address": {
81          "type": "object",
82          "required": [
83            "area_code_slug",
84            "country_code",
85            "name",
86            "tags",
87            "expire_at",
88            "address",
89            "phone",
90            "_custom_json",
91            "checkout_mode",
92            "app_id",
93            "uid",
94            "state",
95            "is_default_address",
96            "_id",
97            "city",
98            "country",
99            "user_id",
100            "area_code"
101          ],
102          "properties": {
103            "_id": {
104              "type": "string",
105              "description": "Unique identifier for the address mongo object."
106            },
107            "uid": {
108              "type": "integer",
109              "description": "Unique identifier of the address object."
110            },
111            "area": {
112              "type": "string",
113              "description": "Building Name/ Street."
114            },
115            "city": {
116              "type": "string",
117              "description": "City name."
118            },
119            "name": {
120              "type": "string",
121              "description": "Name of the user."
122            },
123            "tags": {
124              "type": "array",
125              "description": "Value to add to identify a group of addresses.",
126              "items": {
127                "type": "string"
128              }
129            },
130            "email": {
131              "type": [
132                "null",
133                "string"
134              ],
135              "description": "Email id of the user, can be null."
136            },
137            "phone": {
138              "type": "integer",
139              "description": "Phone number of the user."
140            },
141            "state": {
142              "type": "string",
143              "description": "State name."
144            },
145            "app_id": {
146              "type": "string",
147              "description": "Application id."
148            },
149            "address": {
150              "type": "string",
151              "description": "Flat No/House No/Building No."
152            },
153            "country": {
154              "type": "string",
155              "description": "Country name."
156            },
157            "user_id": {
158              "type": "string",
159              "description": "User Id of the user."
160            },
161            "landmark": {
162              "type": "string",
163              "description": "Landmark."
164            },
165            "area_code": {
166              "type": "string",
167              "description": "pincode or zipcode."
168            },
169            "expire_at": {
170              "type": [
171                "null",
172                "string"
173              ],
174              "description": "Expiry for the address, can be null."
175            },
176            "_custom_json": {
177              "type": "object",
178              "description": "Custom data for the address/user."
179            },
180            "address_type": {
181              "type": "string",
182              "description": "This would represent the type of the address."
183            },
184            "country_code": {
185              "type": "string",
186              "description": "Country code."
187            },
188            "geo_location": {
189              "type": "object",
190              "required": [
191                "latitude",
192                "longitude"
193              ],
194              "properties": {
195                "latitude": {
196                  "type": "number"
197                },
198                "longitude": {
199                  "type": "number"
200                }
201              },
202              "description": "Geographic location e.g., latitude/longitude."
203            },
204            "checkout_mode": {
205              "type": "string",
206              "description": "Checkout type of the user."
207            },
208            "area_code_slug": {
209              "type": "string",
210              "description": "Slug for area code e.g., pincode or zipcode."
211            },
212            "sector": {
213              "type": "string",
214              "description": "Sector will represent the sector for that address."
215            },
216            "state_code": {
217              "type": "string",
218              "description": "Sector will represent the code for that state."
219            },
220            "is_default_address": {
221              "type": "boolean",
222              "description": "Boolean for default address of the user."
223            }
224          }
225        }
226      }
227    }
228  }
229}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "megatron.0d2300ad-00f5-493c-bfdd-a350ffc05f49"
5    ],
6    "name": "address",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712210110937,
10    "id": "VMh6ikastS4S6dvuRefSRImoOEzGe87jFgQXyHAzKv4=",
11    "category": "application"
12  },
13  "company_id": 61,
14  "application_id": "64f038190f62808b5a922f16",
15  "contains": [
16    "address"
17  ],
18  "payload": {
19    "address": {
20      "phone": 1111111111,
21      "uid": 5717753,
22      "tags": [],
23      "country_code": "+91",
24      "user_id": "65a66d01c48e8f9870441d7d",
25      "city": "Mumbai",
26      "country": "India",
27      "app_id": "64f038190f62808b5a922f16",
28      "checkout_mode": "self",
29      "_custom_json": {},
30      "_id": "65a66d014310788f24728a5e",
31      "state_code": "",
32      "state": "Maharashtra",
33      "area": "Dummy areas",
34      "is_default_address": true,
35      "area_code": "400078",
36      "name": "test user",
37      "expire_at": null,
38      "area_code_slug": "pincode",
39      "sector": "",
40      "email": "test@example.com",
41      "landmark": "Tesy",
42      "address": "501"
43    }
44  }
45}

Address/address/delete/v1

this event is triggered when address is deleted

Payload
Hide
application_id
array|string
Required
Application/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": "Application/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      "required": [
77        "address"
78      ],
79      "properties": {
80        "address": {
81          "type": "object",
82          "required": [
83            "area_code_slug",
84            "country_code",
85            "name",
86            "tags",
87            "expire_at",
88            "address",
89            "phone",
90            "_custom_json",
91            "checkout_mode",
92            "app_id",
93            "uid",
94            "state",
95            "is_default_address",
96            "_id",
97            "city",
98            "country",
99            "user_id",
100            "area_code"
101          ],
102          "properties": {
103            "_id": {
104              "type": "string",
105              "description": "Unique identifier for the address mongo object."
106            },
107            "uid": {
108              "type": "integer",
109              "description": "Unique identifier of the address object."
110            },
111            "area": {
112              "type": "string",
113              "description": "Building Name/ Street*."
114            },
115            "city": {
116              "type": "string",
117              "description": "City name."
118            },
119            "name": {
120              "type": "string",
121              "description": "Name of the user."
122            },
123            "tags": {
124              "type": "array",
125              "description": "Value to add to identify a group of address.",
126              "items": {
127                "type": "string"
128              }
129            },
130            "email": {
131              "type": [
132                "null",
133                "string"
134              ],
135              "description": "Email id of user."
136            },
137            "phone": {
138              "type": "integer",
139              "description": "Phone number of user."
140            },
141            "state": {
142              "type": "string",
143              "description": "State name."
144            },
145            "app_id": {
146              "type": "string",
147              "description": "Application id."
148            },
149            "address": {
150              "type": "string",
151              "description": "Flat No/House No/Building No."
152            },
153            "country": {
154              "type": "string",
155              "description": "Country name."
156            },
157            "user_id": {
158              "type": "string",
159              "description": "User Id of the user."
160            },
161            "landmark": {
162              "type": "string",
163              "description": "Landmark."
164            },
165            "area_code": {
166              "type": "string",
167              "description": "pincode or zipcode.."
168            },
169            "expire_at": {
170              "type": [
171                "null",
172                "string"
173              ],
174              "description": "Expiry for address."
175            },
176            "_custom_json": {
177              "type": "object",
178              "description": "Custom data for address/user."
179            },
180            "address_type": {
181              "type": "string",
182              "description": "This would represent the name of the address."
183            },
184            "country_code": {
185              "type": "string",
186              "description": "Country code."
187            },
188            "geo_location": {
189              "type": "object",
190              "required": [
191                "latitude",
192                "longitude"
193              ],
194              "properties": {
195                "latitude": {
196                  "type": "number"
197                },
198                "longitude": {
199                  "type": "number"
200                }
201              },
202              "description": "Geographic location e.g. latitude/longitude."
203            },
204            "checkout_mode": {
205              "type": "string",
206              "description": "Checkout type of user."
207            },
208            "area_code_slug": {
209              "type": "string",
210              "description": "Slug for area code e.g. pincode or zipcode."
211            },
212            "sector": {
213              "type": "string",
214              "description": "Sector will represent the sector for that address."
215            },
216            "state_code": {
217              "type": "string",
218              "description": "Sector will represent the code for that state."
219            },
220            "is_default_address": {
221              "type": "boolean",
222              "description": "Boolean for default address of user."
223            }
224          }
225        }
226      }
227    }
228  }
229}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "megatron.49245abb-5fcc-4134-bdd4-4a0daefd004a"
5    ],
6    "name": "address",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712162915740,
10    "id": "sVTG/vvln7WClX8S7+4me2swfV2K81OiS488Gk0B5qE=",
11    "category": "application"
12  },
13  "company_id": 5842,
14  "application_id": "6523fa5f41f4eb4c10a1d869",
15  "contains": [
16    "address"
17  ],
18  "payload": {
19    "address": {
20      "country": "India",
21      "area_code": "500008",
22      "state_code": "",
23      "state": "Telangana",
24      "address": "Dummy area",
25      "expire_at": null,
26      "country_code": "+91",
27      "tags": [],
28      "user_id": "65faabf928bb65b47f484c94",
29      "area": "Dummy address",
30      "city": "Hyderabad",
31      "checkout_mode": "self",
32      "name": "dummy user",
33      "uid": 5786605,
34      "app_id": "6523fa5f41f4eb4c10a1d869",
35      "landmark": "Dummy landmark",
36      "sector": "",
37      "area_code_slug": "pincode",
38      "geo_location": {
39        "latitude": 28.6667,
40        "longitude": 77.2167
41      },
42      "address_type": "Friend & Family",
43      "phone": 1111111111,
44      "_id": "660bd2a5905869cdd609af5e",
45      "is_default_address": false,
46      "_custom_json": {},
47      "email": "test@example.com"
48    }
49  }
50}

Previous
« support-ticket/create/v1
Next
article/create/v1 »