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.

Domain

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

Events

application/domain/create/v1

# this event is triggered when domain is created

application/domain/delete/v1

# this event is triggered when domain is deleted

Domain/domain/create/v1

this event is triggered when domain 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 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        "domain"
78      ],
79      "properties": {
80        "domain": {
81          "type": "object",
82          "description": "An object representing a domain, which typically includes various attributes and properties related to a specific domain.",
83          "required": [
84            "id",
85            "name",
86            "verified",
87            "is_primary",
88            "is_shortLink"
89          ],
90          "properties": {
91            "id": {
92              "type": "string",
93              "description": "ID of the created domain"
94            },
95            "name": {
96              "type": "string",
97              "description": "URL of the domain"
98            },
99            "verified": {
100              "type": "boolean",
101              "description": "Shows if the domain is verified or not"
102            },
103            "is_primary": {
104              "type": "boolean",
105              "description": "Shows if the domain is primary or not"
106            },
107            "is_shortLink": {
108              "type": "boolean",
109              "description": "This Boolean field indicates whether the domain is a short link or not."
110            }
111          }
112        }
113      }
114    }
115  }
116}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "slingshot.713856c7-5a08-4476-ae0b-9407b50b8c54"
5    ],
6    "name": "domain",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712043569378,
10    "id": "xmejd99gGMIxiIc9RWvFxUZ/t9Q8JJeFefVr13yMymU=",
11    "category": "application"
12  },
13  "company_id": 6654,
14  "application_id": "65a6edddbc250d9e3be73e19",
15  "contains": [
16    "domain"
17  ],
18  "payload": {
19    "domain": {
20      "id": "660bb6310b32949adcc54b0f",
21      "name": "junziuae.fynd.io",
22      "verified": true,
23      "is_primary": false,
24      "is_shortLink": false
25    }
26  }
27}

Domain/domain/delete/v1

this event is triggered when domain 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        "domain"
78      ],
79      "properties": {
80        "domain": {
81          "description": "An object representing a domain, which typically includes various attributes and properties related to a specific domain.",
82          "type": "object",
83          "required": [
84            "id",
85            "name",
86            "verified",
87            "is_primary",
88            "is_shortLink"
89          ],
90          "properties": {
91            "id": {
92              "type": "string",
93              "description": "ID of the created domain"
94            },
95            "name": {
96              "type": "string",
97              "description": "URL of the domain"
98            },
99            "verified": {
100              "type": "boolean",
101              "description": "Shows if the domain is verified or not"
102            },
103            "is_primary": {
104              "type": "boolean",
105              "description": "Shows if the domain is primary or not"
106            },
107            "is_shortLink": {
108              "type": "boolean",
109              "description": "This Boolean field indicates whether the domain is a short link or not."
110            }
111          }
112        }
113      }
114    }
115  }
116}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "slingshot.713856c7-5a08-4476-ae0b-9407b50b8c54"
5    ],
6    "name": "domain",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712043569378,
10    "id": "xmejd99gGMIxiIc9RWvFxUZ/t9Q8JJeFefVr13yMymU=",
11    "category": "application"
12  },
13  "company_id": 6654,
14  "application_id": "65a6edddbc250d9e3be73e19",
15  "contains": [
16    "domain"
17  ],
18  "payload": {
19    "domain": {
20      "id": "660bb6310b32949adcc54b0f",
21      "name": "junziuae.fynd.io",
22      "verified": true,
23      "is_primary": false,
24      "is_shortLink": false
25    }
26  }
27}

« discount/create/v1

faq/create/v1 »