Application
Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.
Events
application/collection/create/v2
# this event is triggered when collection is created
application/collection/update/v2
# this event is triggered when collection is updated
application/collection/delete/v2
# this event is triggered when collection 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": "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 "collection"78 ],79 "properties": {80 "collection": {81 "type": "object",82 "properties": {83 "seo": {84 "type": "object",85 "description": "SEO details for the collection, with a title and description.",86 "properties": {87 "title": {88 "type": "string",89 "description": "The title for SEO of the collection."90 },91 "description": {92 "type": "string",93 "description": "The description for SEO of the collection."94 }95 }96 },97 "cron": {98 "type": "object",99 "description": ""100 },101 "logo": {102 "type": "object",103 "properties": {104 "url": {105 "type": "string",106 "description": "The URL of the image for the collection's logo."107 },108 "aspect_ratio": {109 "type": "string",110 "description": "The aspect ratio of the image for the collection's logo."111 }112 },113 "description": "Logo image for the collection."114 },115 "meta": {116 "type": "object",117 "description": "Additional metadata for the collection."118 },119 "name": {120 "type": "string",121 "description": "Name of the collection."122 },123 "slug": {124 "type": "string",125 "description": "Unique identifier for the collection."126 },127 "tags": {128 "type": "array",129 "items": {130 "type": "string"131 },132 "description": "List of tags associated with the collection."133 },134 "type": {135 "type": "string",136 "description": "Type of the collection, e.g. 'editorial' or 'product'."137 },138 "badge": {139 "type": "object",140 "properties": {141 "text": {142 "type": "string",143 "description": "The text of the badge for the collection."144 },145 "color": {146 "type": "string",147 "description": "The color of the badge for the collection."148 }149 },150 "description": "Badge for the collection, with a color and text."151 },152 "query": {153 "type": "array",154 "items": {155 "type": "object",156 "required": [157 "attribute",158 "op",159 "value"160 ],161 "properties": {162 "op": {163 "enum": [164 "in",165 "nin",166 "gt",167 "gte",168 "lt",169 "lte",170 "btw"171 ],172 "type": "string"173 },174 "value": {175 "type": "array",176 "items": {177 "type": [178 "string",179 "number"180 ]181 }182 },183 "attribute": {184 "type": "string"185 }186 }187 },188 "description": "Filter queries for the collection."189 },190 "action": {191 "type": "object",192 "properties": {193 "page": {194 "type": "object",195 "properties": {196 "type": {197 "type": "string",198 "description": "Type of page associated with the action of the collection."199 },200 "query": {201 "type": "object",202 "description": "Query associated with the page action of the collection."203 }204 },205 "description": "Page associated with the action of the collection."206 },207 "type": {208 "type": "string",209 "description": "Type of action associated with the collection."210 }211 },212 "description": "Action associated with the collection."213 },214 "app_id": {215 "type": "string",216 "description": "ID of the app the collection belongs to."217 },218 "banners": {219 "type": "object",220 "required": [221 "landscape",222 "portrait"223 ],224 "properties": {225 "portrait": {226 "type": "object",227 "properties": {228 "url": {229 "type": "string",230 "description": "The URL of the portrait image of the collection banner."231 },232 "aspect_ratio": {233 "type": "string",234 "description": "The aspect ratio of the portrait image of the collection banner."235 }236 },237 "description": "The portrait image of the collection banner."238 },239 "landscape": {240 "type": "object",241 "properties": {242 "url": {243 "type": "string",244 "description": "The URL of the landscape image of the collection banner."245 },246 "aspect_ratio": {247 "type": "string",248 "description": "The aspect ratio of the landscape image of the collection banner."249 }250 },251 "description": "The landscape image of the collection banner."252 }253 },254 "description": "Banner images for the collection, with a portrait and landscape version."255 },256 "sort_on": {257 "type": "string",258 "description": "The default sort order for the collection, e.g. 'popular'."259 },260 "priority": {261 "type": "integer",262 "description": "Priority of the collection, used for sorting."263 },264 "_schedule": {265 "type": "object",266 "properties": {267 "end": {268 "type": "string",269 "description": "The end time of the job for the collection."270 },271 "cron": {272 "type": "string",273 "description": "The cron expression for the schedule of the collection."274 },275 "start": {276 "type": "string",277 "description": "The start time of the job for the collection."278 },279 "duration": {280 "type": "integer",281 "description": "The duration of the job in seconds for the collection."282 },283 "next_schedule": {284 "type": "array",285 "items": {286 "type": "object",287 "properties": {288 "end": {289 "type": [290 "string",291 "null"292 ]293 },294 "start": {295 "type": "string"296 }297 }298 },299 "description": "The next schedule for the job of the collection."300 }301 },302 "description": "Schedule for the collection."303 },304 "is_active": {305 "type": "boolean",306 "description": "Whether the collection is currently active."307 },308 "allow_sort": {309 "type": "boolean",310 "description": "Whether sorting is allowed for the collection."311 },312 "is_visible": {313 "type": "boolean",314 "description": "Whether the collection is visible or not."315 },316 "description": {317 "type": "string",318 "description": "Description of the collection."319 },320 "_custom_json": {321 "type": "object",322 "description": "Custom JSON data for the collection."323 },324 "allow_facets": {325 "type": "boolean",326 "description": "Whether facets are allowed for the collection."327 },328 "_locale_language": {329 "type": "object",330 "description": "Locale language for the collection."331 },332 "visible_facets_keys": {333 "type": "array",334 "items": {335 "type": "string"336 },337 "description": "List of keys for visible facets in the collection."338 }339 },340 "description": "Collection Data is stored in this object"341 }342 }343 }344 }345}
Payload Example
1{2 "application_id": "6523fa5f41f4eb4c10a1d869",3 "company_id": 5842,4 "contains": [5 "collection"6 ],7 "event": {8 "category": "application",9 "created_timestamp": 1708644940476,10 "id": "gFx0LWac2FBTIAmnrwlX05p0cDVbAc02TU46sTOepIQ=",11 "name": "collection",12 "trace_id": [13 "silverbolt.16bfae2e-d1db-11ee-ae64-b66edc95121c"14 ],15 "type": "create",16 "version": "2"17 },18 "payload": {19 "collection": {20 "_custom_json": {},21 "_locale_language": {},22 "_schedule": {23 "start": "2024-02-22T23:35:33.878Z"24 },25 "action": {26 "page": {27 "query": {28 "collection": [29 "popular-everywhere"30 ]31 },32 "type": "collection"33 },34 "type": "page"35 },36 "allow_facets": true,37 "allow_sort": true,38 "app_id": "6523fa5f41f4eb4c10a1d869",39 "badge": {40 "color": "#ffffff",41 "text": ""42 },43 "banners": {44 "landscape": {45 "type": "image",46 "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"47 },48 "portrait": {49 "type": "image",50 "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"51 }52 },53 "description": "",54 "is_active": true,55 "is_visible": false,56 "logo": {57 "type": "image",58 "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"59 },60 "meta": {},61 "name": "Popular on Google",62 "priority": 9999,63 "published": true,64 "query": [],65 "seo": {66 "breadcrumbs": [67 {}68 ],69 "description": "",70 "meta_tags": [],71 "sitemap": {72 "frequency": "never",73 "priority": 0.574 },75 "title": "Popular on Google"76 },77 "slug": "popular-everywhere",78 "sort_on": "depth_desc",79 "tags": [],80 "type": "items",81 "uid": "65d7da4c3ad8b4f55d9547e7",82 "visible_facets_keys": []83 }84 }85}
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": "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 "collection"78 ],79 "properties": {80 "collection": {81 "type": "object",82 "properties": {83 "slug": {84 "type": "string",85 "description": "Unique identifier for the collection."86 },87 "meta": {88 "type": "object",89 "description": "Additional metadata for the collection."90 },91 "_custom_json": {92 "type": "object",93 "description": "Custom JSON data for the collection."94 },95 "_locale_language": {96 "type": "object",97 "description": "Locale language for the collection."98 },99 "seo": {100 "type": "object",101 "properties": {102 "title": {103 "type": "string",104 "description": "The title for SEO of the collection."105 },106 "description": {107 "type": "string",108 "description": "The description for SEO of the collection."109 }110 },111 "description": "SEO details for the collection, with a title and description."112 },113 "app_id": {114 "type": "string",115 "description": "ID of the app the collection belongs to."116 },117 "sort_on": {118 "type": "string",119 "description": "The default sort order for the collection, e.g. 'popular'."120 },121 "is_visible": {122 "type": "boolean",123 "description": "Whether the collection is visible or not."124 },125 "_schedule": {126 "type": "object",127 "required": [],128 "properties": {129 "cron": {130 "type": "string",131 "description": "The cron expression for the schedule of the collection."132 },133 "next_schedule": {134 "type": "array",135 "items": {136 "type": "object",137 "properties": {138 "start": {139 "type": "string"140 },141 "end": {142 "type": [143 "string",144 "null"145 ]146 }147 }148 },149 "description": "The next schedule for the job of the collection."150 },151 "duration": {152 "type": "integer",153 "description": "The duration of the job in seconds for the collection."154 },155 "start": {156 "type": "string",157 "description": "The start time of the job for the collection."158 },159 "end": {160 "type": "string",161 "description": "The end time of the job for the collection."162 }163 },164 "description": "Schedule for the collection."165 },166 "priority": {167 "type": "integer",168 "description": "Priority of the collection, used for sorting."169 },170 "visible_facets_keys": {171 "type": "array",172 "items": {173 "type": "string"174 },175 "description": "List of keys for visible facets in the collection."176 },177 "badge": {178 "type": "object",179 "required": [],180 "properties": {181 "color": {182 "type": "string",183 "description": "The color of the badge for the collection."184 },185 "text": {186 "type": "string",187 "description": "The text of the badge for the collection."188 }189 },190 "description": "Badge for the collection, with a color and text."191 },192 "banners": {193 "type": "object",194 "required": [195 "landscape",196 "portrait"197 ],198 "properties": {199 "landscape": {200 "type": "object",201 "properties": {202 "aspect_ratio": {203 "type": "string",204 "description": "The aspect ratio of the landscape image of the collection banner."205 },206 "url": {207 "type": "string",208 "description": "The URL of the landscape image of the collection banner."209 }210 },211 "description": "The landscape image of the collection banner."212 },213 "portrait": {214 "type": "object",215 "properties": {216 "aspect_ratio": {217 "type": "string",218 "description": "The aspect ratio of the portrait image of the collection banner."219 },220 "url": {221 "type": "string",222 "description": "The URL of the portrait image of the collection banner."223 }224 },225 "description": "The portrait image of the collection banner."226 }227 },228 "description": "Banner images for the collection, with a portrait and landscape version."229 },230 "type": {231 "type": "string",232 "description": "Type of the collection, e.g. 'editorial' or 'product'."233 },234 "is_active": {235 "type": "boolean",236 "description": "Whether the collection is currently active."237 },238 "cron": {239 "type": "object",240 "description": ""241 },242 "allow_sort": {243 "type": "boolean",244 "description": "Whether sorting is allowed for the collection."245 },246 "name": {247 "type": "string",248 "description": "Name of the collection."249 },250 "tags": {251 "type": "array",252 "items": {253 "type": "string"254 },255 "description": "List of tags associated with the collection."256 },257 "allow_facets": {258 "type": "boolean",259 "description": "Whether facets are allowed for the collection."260 },261 "description": {262 "type": "string",263 "description": "Description of the collection."264 },265 "query": {266 "type": "array",267 "items": {268 "type": "object",269 "properties": {270 "value": {271 "type": "array",272 "items": {273 "type": [274 "string",275 "number"276 ]277 }278 },279 "attribute": {280 "type": "string"281 },282 "op": {283 "type": "string",284 "enum": [285 "in",286 "nin",287 "gt",288 "gte",289 "lt",290 "lte",291 "btw"292 ]293 }294 },295 "required": [296 "attribute",297 "op",298 "value"299 ]300 },301 "description": "Filter queries for the collection."302 },303 "logo": {304 "type": "object",305 "properties": {306 "aspect_ratio": {307 "type": "string",308 "description": "The aspect ratio of the image for the collection's logo."309 },310 "url": {311 "type": "string",312 "description": "The URL of the image for the collection's logo."313 }314 },315 "description": "Logo image for the collection."316 }317 },318 "description": "Collection Data is stored in this object"319 }320 }321 }322 }323}
Payload Example
1{2 "application_id": "65004d091d693d03a2d75948",3 "company_id": 4204,4 "contains": [5 "collection"6 ],7 "event": {8 "category": "application",9 "created_timestamp": 1709553888371,10 "id": "zYKMq0Ns4qHGfl/QauHdYTuyGRx3mHW+A/1WwKivntc=",11 "name": "collection",12 "trace_id": [13 "silverbolt.65e9a274-da1f-11ee-8d18-a6bef371a5fd"14 ],15 "type": "update",16 "version": "2"17 },18 "payload": {19 "collection": {20 "_custom_json": {},21 "_locale_language": {},22 "_schedule": {23 "end": "9998-01-30T23:59:00",24 "next_schedule": [25 {26 "end": "9998-01-30T23:59:00",27 "start": "2023-10-03T23:40:10.464000"28 }29 ],30 "start": "2023-10-03T23:40:10.464000"31 },32 "allow_facets": true,33 "allow_sort": true,34 "app_id": "65004d091d693d03a2d75948",35 "badge": {36 "color": "#ffffff",37 "text": ""38 },39 "banners": {40 "landscape": {41 "type": "image",42 "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857999/production/applications/app_000000000000000000000001/media/collection/landscape/avm7xibo2jgk8glc4bwl.png"43 },44 "portrait": {45 "type": "image",46 "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588858137/production/applications/app_000000000000000000000001/media/collection/portrait/xzuftshmmw4yuwzb12pm.png"47 }48 },49 "description": "",50 "is_active": true,51 "is_visible": true,52 "logo": {53 "type": "image",54 "url": "https://res.cloudinary.com/dwzm9bysq/image/upload/v1588857854/production/applications/app_000000000000000000000001/media/collection/logo/w9ns7nfgv7fk45xqrpoh.png"55 },56 "meta": {},57 "name": "Occasions",58 "priority": 97,59 "published": true,60 "query": [61 {62 "attribute": "custom-attribute-5",63 "op": "in",64 "value": [65 "Brunches",66 "Destination Wedding",67 "Evening Enchantments",68 "Everyday Luxe",69 "Festive Glamour",70 "Print Parade",71 "Resort Rendezvous",72 "Signature Classics"73 ]74 }75 ],76 "seo": {77 "breadcrumbs": [78 {}79 ],80 "description": "Nothing but the best for you. Handpicked from an ethereal collection of designer-wear to suit your exact taste.",81 "meta_tags": [],82 "sitemap": {83 "frequency": "never",84 "priority": 0.585 },86 "title": "Dress for the Occassion | Gulabo by Abu Sandeep"87 },88 "slug": "occasions",89 "sort_on": "popular",90 "tags": [],91 "type": "query",92 "uid": "651ca80077451e1b22a144c2",93 "visible_facets_keys": []94 }95 }96}
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": "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 "collection"78 ],79 "properties": {80 "collection": {81 "type": "object",82 "required": [83 "id",84 "app_id"85 ],86 "properties": {87 "id": {88 "type": "string",89 "description": "ID of the collection."90 },91 "app_id": {92 "type": "string",93 "description": "ID of the app the collection belongs to."94 }95 },96 "description": "Collection Data is stored in this object"97 }98 }99 }100 }101}
Payload Example
1{2 "application_id": "5d63686df2a4f7806b76bb32",3 "company_id": 61,4 "contains": [5 "collection"6 ],7 "event": {8 "category": "application",9 "created_timestamp": 1712150505804,10 "id": "X5g4+7nnniqZFu8z7goRW8V1JkJX35f6pOxbsEQTSmI=",11 "name": "collection",12 "trace_id": [13 "silverbolt.1e828ddc-f1bd-11ee-8193-26f8b25d5ea6"14 ],15 "type": "delete",16 "version": "2"17 },18 "payload": {19 "collection": {20 "app_id": "5d63686df2a4f7806b76bb32",21 "id": "660d565cf796d12bd720a7ae"22 }23 }24}