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.

Seo

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

Events

application/seo/update/v1

# this event is triggered when seo is updated

Seo/seo/update/v1

this event is triggered when seo 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 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        "seo"
78      ],
79      "properties": {
80        "seo": {
81          "type": "object",
82          "required": [
83            "details",
84            "robots_txt",
85            "sitemap_enabled",
86            "_id",
87            "custom_meta_tags",
88            "app",
89            "createdAt",
90            "updatedAt",
91            "__v"
92          ],
93          "properties": {
94            "__v": {
95              "type": "integer"
96            },
97            "_id": {
98              "type": "string"
99            },
100            "app": {
101              "type": "string",
102              "description": "sales channel ID to which the SEO is related"
103            },
104            "details": {
105              "type": "object",
106              "description": "SEO details containing the `title` and `description` that would show up on the web search results",
107              "required": [
108                "title",
109                "description"
110              ],
111              "properties": {
112                "title": {
113                  "type": "string"
114                },
115                "description": {
116                  "type": "string"
117                }
118              }
119            },
120            "createdAt": {
121              "type": "string"
122            },
123            "updatedAt": {
124              "type": "string"
125            },
126            "robots_txt": {
127              "type": "string",
128              "description": "Content of /robots.txt file"
129            },
130            "sitemap_enabled": {
131              "type": "boolean",
132              "description": "Shows whether the sitemap is enabled for exposing all the URLs of the website to web crawlers/bots"
133            },
134            "custom_meta_tags": {
135              "type": "array",
136              "description": "List of custom meta tags that are injected in HTML and used by crawlers/bots",
137              "items": [
138                {
139                  "type": "object",
140                  "required": [
141                    "name",
142                    "content",
143                    "_id"
144                  ],
145                  "properties": {
146                    "_id": {
147                      "type": "string"
148                    },
149                    "name": {
150                      "type": "string"
151                    },
152                    "content": {
153                      "type": "string"
154                    }
155                  }
156                }
157              ]
158            }
159          }
160        }
161      }
162    }
163  }
164}

Payload Example

1{
2  "event": {
3    "id": "rOcs838XXrj5ef6LoJkfu9y3TTW25tDekAsleAA4Eck=",
4    "name": "seo",
5    "type": "update",
6    "version": "1",
7    "category": "application",
8    "trace_id": [
9      "convex.f4009557-4cb2-46c2-b8f8-769aaf8e8855"
10    ],
11    "created_timestamp": 1661319161914
12  },
13  "payload": {
14    "seo": {
15      "details": {
16        "title": "A.projeKt by Asmita Kala",
17        "description": "Contemporary Indian wear for women. \nContact: +91 8888888888"
18      },
19      "robots_txt": "User-agent: *\nDisallow: /dashboard/\nDisallow: /order/\nDisallow: /address_book/\nDisallow: /return/\nDisallow: /wishlist/\nDisallow: /cart/\nDisallow: /checkout/\nDisallow: /thankyou/\n\nSitemap:https://www.aprojekt.in/sitemap.xml",
20      "sitemap_enabled": true,
21      "_id": "60a24494eac74ae12d1a6551",
22      "app": "5f79bf6d3a35c3670c134b34",
23      "custom_meta_tags": [
24        {
25          "name": "ahref domain verification",
26          "content": "<meta name=\"ahrefs-site-verification\" content=\"8fd0bc49d8b5e677c269c63c354380428d5bef1d6f9ae62f455ba058ad8b4d01\">\n",
27          "_id": "62f654988c4facdbf76e24a2"
28        }
29      ],
30      "createdAt": "2021-05-17T10:25:24.386Z",
31      "updatedAt": "2022-08-17T09:12:17.075Z",
32      "__v": 1
33    }
34  },
35  "contains": [
36    "seo"
37  ],
38  "company_id": 2,
39  "application_id": "000000000000000000000001"
40}

« rma_rule/create/v2

shipment/create/v1 »