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.

Faq

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

Events

application/faq/create/v1

# this event is triggered when faq is created

application/faq/update/v1

# this event is triggered when faq is updated

application/faq/delete/v1

# this event is triggered when faq is deleted

Faq/faq/create/v1

this event is triggered when faq is created

Payload

Properties

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

Properties

category

string

Required

category of the event. If it is at sales channel level or company level

created_timestamp

integer

Required

event generation timestamp in epoch milliseconds

string

Required

Unique ID for an event. This id can be used to verifiy if event is already processed by receiver

name

string

Required

Name of the event

trace_id

array of string

Required

internal trace_id for Fynd Platform services

type

string

Required

Type/Action of the event. e.g. create/update/delete

version

string

Required

Version of the event.

payload

object

Required

Properties

faq

object

Required

Properties

__v

integer

Required

_id

string

Required

slug

string

Required

Last part of a Human readable URL where the FAQ details can be found

answer

string

Required

Details related to the answer

question

string

Required

Details related to the question

application

string

Required

sales channel ID to which this FAQ is related

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        "faq"
78      ],
79      "properties": {
80        "faq": {
81          "type": "object",
82          "required": [
83            "_id",
84            "question",
85            "answer",
86            "slug",
87            "application",
88            "__v"
89          ],
90          "properties": {
91            "__v": {
92              "type": "integer"
93            },
94            "_id": {
95              "type": "string"
96            },
97            "slug": {
98              "type": "string",
99              "description": "Last part of a Human readable URL where the FAQ details can be found"
100            },
101            "answer": {
102              "type": "string",
103              "description": "Details related to the answer"
104            },
105            "question": {
106              "type": "string",
107              "description": "Details related to the question"
108            },
109            "application": {
110              "type": "string",
111              "description": "sales channel ID to which this FAQ is related"
112            }
113          }
114        }
115      }
116    }
117  }
118}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.92b267a9-682a-4f06-b3ac-bd7e5fde92e8"
5    ],
6    "name": "faq",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712050560823,
10    "id": "6kEedI7OCSRV0i+kuwm26eV9TBGXipeBgqI1Ka/6F1A=",
11    "category": "application"
12  },
13  "company_id": 6902,
14  "application_id": "65d2fb0cbe02fc23cf17d45f",
15  "contains": [
16    "faq"
17  ],
18  "payload": {
19    "faq": {
20      "application": "65d2fb0cbe02fc23cf17d45f",
21      "slug": "fa",
22      "question": "How did NutriWellments get its name?",
23      "answer": "***The name NutriWellments is derived from \"nutrition,\" \"wellbeing,\" and \"supplements,\" reflecting our commitment to comprehensive health support.***",
24      "tags": [],
25      "_id": "660bd1805c786cf7642d8f81",
26      "__v": 0
27    }
28  }
29}

Faq/faq/update/v1

this event is triggered when faq is updated

Payload

Properties

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

Properties

category

string

Required

category of the event. If it is at sales channel level or company level

created_timestamp

integer

Required

event generation timestamp in epoch milliseconds

string

Required

Unique ID for an event. This id can be used to verifiy if event is already processed by receiver

name

string

Required

Name of the event

trace_id

array of string

Required

internal trace_id for Fynd Platform services

type

string

Required

Type/Action of the event. e.g. create/update/delete

version

string

Required

Version of the event.

payload

object

Required

Properties

faq

object

Required

Properties

__v

integer

Required

_id

string

Required

slug

string

Required

Last part of a Human readable URL where the FAQ details can be found

answer

string

Required

Details related to the answer

question

string

Required

Details related to the question

application

string

Required

sales channel ID to which this FAQ is related

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        "faq"
78      ],
79      "properties": {
80        "faq": {
81          "type": "object",
82          "required": [
83            "_id",
84            "question",
85            "answer",
86            "slug",
87            "application",
88            "__v"
89          ],
90          "properties": {
91            "__v": {
92              "type": "integer"
93            },
94            "_id": {
95              "type": "string"
96            },
97            "slug": {
98              "type": "string",
99              "description": "Last part of a Human readable URL where the FAQ details can be found"
100            },
101            "answer": {
102              "type": "string",
103              "description": "Details related to the answer"
104            },
105            "question": {
106              "type": "string",
107              "description": "Details related to the question"
108            },
109            "application": {
110              "type": "string",
111              "description": "sales channel ID to which this FAQ is related"
112            }
113          }
114        }
115      }
116    }
117  }
118}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.e28ebd58-a1b7-4319-8187-d743c214e4e6"
5    ],
6    "name": "faq",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712050804033,
10    "id": "CKNFtYVNdFzHguonUnbsCAmpANX8zzyzSNNMK7Vw/Gw=",
11    "category": "application"
12  },
13  "company_id": 6902,
14  "application_id": "65d2fb0cbe02fc23cf17d45f",
15  "contains": [
16    "faq"
17  ],
18  "payload": {
19    "faq": {
20      "_id": "660bd1805c786cf7642d8f81",
21      "application": "65d2fb0cbe02fc23cf17d45f",
22      "slug": "fa",
23      "question": "How did NutriWellments get its name?",
24      "answer": "The name NutriWellments is derived from \"nutrition,\" \"wellbeing,\" and \"supplements,\" reflecting our commitment to comprehensive health support.",
25      "tags": [],
26      "__v": 0
27    }
28  }
29}

Faq/faq/delete/v1

this event is triggered when faq is deleted

Payload

Properties

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

Properties

category

string

Required

category of the event. If it is at sales channel level or company level

created_timestamp

integer

Required

event generation timestamp in epoch milliseconds

string

Required

Unique ID for an event. This id can be used to verifiy if event is already processed by receiver

name

string

Required

Name of the event

trace_id

array of string

Required

internal trace_id for Fynd Platform services

type

string

Required

Type/Action of the event. e.g. create/update/delete

version

string

Required

Version of the event.

payload

object

Required

Properties

faq

object

Required

Properties

__v

integer

Required

_id

string

Required

slug

string

Required

Last part of a Human readable URL where the FAQ details can be found

answer

string

Required

Details related to the answer

question

string

Required

Details related to the question

application

string

Required

sales channel ID to which this FAQ is related

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        "faq"
78      ],
79      "properties": {
80        "faq": {
81          "type": "object",
82          "required": [
83            "_id",
84            "question",
85            "answer",
86            "slug",
87            "application",
88            "__v"
89          ],
90          "properties": {
91            "__v": {
92              "type": "integer"
93            },
94            "_id": {
95              "type": "string"
96            },
97            "slug": {
98              "type": "string",
99              "description": "Last part of a Human readable URL where the FAQ details can be found"
100            },
101            "answer": {
102              "type": "string",
103              "description": "Details related to the answer"
104            },
105            "question": {
106              "type": "string",
107              "description": "Details related to the question"
108            },
109            "application": {
110              "type": "string",
111              "description": "sales channel ID to which this FAQ is related"
112            }
113          }
114        }
115      }
116    }
117  }
118}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.32f769e4-b310-42d1-b4c7-79d32f9faf17"
5    ],
6    "name": "faq",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712050213101,
10    "id": "7if3+DeqSJ/8qWnv/RltI4UYEJlAtzMYPVAamPALkDA=",
11    "category": "application"
12  },
13  "company_id": 6902,
14  "application_id": "65d2fb0cbe02fc23cf17d45f",
15  "contains": [
16    "faq"
17  ],
18  "payload": {
19    "faq": {
20      "_id": "65f422c8b13e657d086d7f53",
21      "application": "65d2fb0cbe02fc23cf17d45f",
22      "slug": "faqs",
23      "question": "Have the supplements been tested?",
24      "answer": "Yes, our supplements undergo rigorous testing to ensure quality, safety, and efficacy. We prioritize transparency.",
25      "tags": [],
26      "__v": 0
27    }
28  }
29}

« domain/create/v1

filter/create/v1 »