Extension

Events categorised under extension level will be triggered when any action performed on extension. e.g. If extension is installed.

Extension

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

Events

extension/extension/install/v1

# this event is triggered when extension is installed

extension/extension/uninstall/v1

# this event is triggered when extension is uninstalled

Extension/extension/install/v1

this event is triggered when extension is installed

Payload

Hide

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  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "required": [
69        "extension",
70        "company",
71        "installed_on"
72      ],
73      "properties": {
74        "company": {
75          "type": "object",
76          "required": [
77            "id",
78            "name",
79            "email"
80          ],
81          "properties": {
82            "id": {
83              "type": "integer",
84              "description": "Company id where extension is being installed or uninstalled"
85            },
86            "name": {
87              "type": "string",
88              "description": "Name of company where extension is installed or uninstalled"
89            },
90            "email": {
91              "type": "string",
92              "description": "Company's primary contact email"
93            }
94          }
95        },
96        "extension": {
97          "type": "object",
98          "required": [
99            "id",
100            "extension_type",
101            "name",
102            "base_url",
103            "organization_id"
104          ],
105          "properties": {
106            "id": {
107              "type": "string",
108              "description": "Extension ID or API_KEY"
109            },
110            "name": {
111              "type": "string",
112              "description": "Extension name"
113            },
114            "base_url": {
115              "type": "string",
116              "description": "Extension launch url"
117            },
118            "extension_type": {
119              "type": "string",
120              "description": "Type of extension private/public"
121            },
122            "organization_id": {
123              "type": "string",
124              "description": "Extension Creator - Partner Organization id"
125            }
126          }
127        },
128        "installed_on": {
129          "type": "string",
130          "description": "Date ISOString on extension is installed. (Only present for install type event)"
131        }
132      }
133    }
134  }
135}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "skywarp-panel.c3296507-553f-4754-a311-24ac201fbe3f"
5    ],
6    "name": "extension",
7    "type": "install",
8    "version": "1",
9    "created_timestamp": 1712042224135,
10    "id": "3Kfe8LiKkqEXibjef6HoW69z56SjwWQyI2S0m8C3KMo=",
11    "category": "extension"
12  },
13  "company_id": 6811,
14  "contains": [
15    "extension",
16    "company",
17    "installed_on"
18  ],
19  "payload": {
20    "extension": {
21      "id": "65e54deed85c58b8a10696c8",
22      "extension_type": "private",
23      "name": "visenze_fynd_dev-local",
24      "base_url": "https://e8eb-158-140-146-52.ngrok-free.app",
25      "organization_id": "65b8de9ca2c2434448480f5e"
26    },
27    "company": {
28      "id": 6811,
29      "name": "Visenze_caglar_test",
30      "email": "test@example.com"
31    },
32    "installed_on": "2024-04-02T07:17:03.817Z"
33  }
34}

Extension/extension/uninstall/v1

this event is triggered when extension is uninstalled

Payload

Hide

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  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "required": [
69        "extension",
70        "company",
71        "uninstall_message",
72        "uninstalled_on"
73      ],
74      "properties": {
75        "extension": {
76          "type": "object",
77          "required": [
78            "id",
79            "extension_type",
80            "name",
81            "base_url",
82            "organization_id"
83          ],
84          "properties": {
85            "id": {
86              "type": "string",
87              "description": "Extension ID or API_KEY"
88            },
89            "extension_type": {
90              "type": "string",
91              "description": "Type of extension private/public"
92            },
93            "name": {
94              "type": "string",
95              "description": "Extension name"
96            },
97            "base_url": {
98              "type": "string",
99              "description": "Extension launch url"
100            },
101            "organization_id": {
102              "type": "string",
103              "description": "Extension Creator - Partner Organization id"
104            }
105          }
106        },
107        "company": {
108          "type": "object",
109          "required": [
110            "id",
111            "name",
112            "email"
113          ],
114          "properties": {
115            "id": {
116              "type": "integer",
117              "description": "Company id where extension is being installed or uninstalled"
118            },
119            "name": {
120              "type": "string",
121              "description": "Name of company where extension is installed or uninstalled"
122            },
123            "email": {
124              "type": "string",
125              "description": "Company's primary contact email"
126            }
127          }
128        },
129        "uninstall_message": {
130          "type": "string",
131          "description": "Seller submittted reason for uninstalling extension (Only present for uninstall type event)"
132        },
133        "uninstalled_on": {
134          "type": "string",
135          "description": "Date ISOString on extension is uninstalled. (Only present for uninstall type event)"
136        }
137      }
138    }
139  }
140}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "mixmaster.37455a22-1d6c-4f0e-b07d-0f41b3cf7e9e"
5    ],
6    "name": "extension",
7    "type": "uninstall",
8    "version": "1",
9    "created_timestamp": 1712042137008,
10    "id": "oRr/sglUO8pA6diPjGeDezx1ksodQeVuC30WFF6xSWY=",
11    "category": "extension"
12  },
13  "company_id": 6811,
14  "contains": [
15    "extension",
16    "company",
17    "uninstall_message",
18    "uninstalled_on"
19  ],
20  "payload": {
21    "extension": {
22      "id": "65e54deed85c58b8a10696c8",
23      "name": "visenze_fynd_dev-local",
24      "base_url": "https://98d4-158-140-146-52.ngrok-free.app",
25      "organization_id": "65b8de9ca2c2434448480f5e",
26      "launch_type": "company",
27      "extension_type": "private"
28    },
29    "company": {
30      "id": 6811,
31      "name": "Visenze_caglar_test",
32      "email": "test@example.com"
33    },
34    "uninstall_message": "",
35    "uninstalled_on": "2024-04-02T07:15:36.291Z"
36  }
37}

« department/create/v1

extension-subscription/create/v1 »