Company

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        "ticket"
70      ],
71      "properties": {
72        "ticket": {
73          "type": "object",
74          "description": "The support ticket object associated with the event",
75          "required": [
76            "_id",
77            "content",
78            "category",
79            "status",
80            "priority"
81          ],
82          "properties": {
83            "_id": {
84              "type": "string",
85              "description": "Primary Identifier used for retrieving and updating the ticket"
86            },
87            "tags": {
88              "type": "array",
89              "description": "Array of string describing relevant tags to the ticket",
90              "items": {
91                "type": "string"
92              }
93            },
94            "source": {
95              "type": "string",
96              "description": "The type of origin of ticket - It can be either raised at platfom panel, partner panel or sales channel"
97            },
98            "status": {
99              "type": "string",
100              "description": "Describes the status of the ticket. Possible values: open, pending, in_progress, resolved, closed"
101            },
102            "content": {
103              "type": "object",
104              "description": "Contains title, base 64 encoded description (HTML), and list of attachments",
105              "required": [
106                "title",
107                "description"
108              ],
109              "properties": {
110                "title": {
111                  "type": "string",
112                  "description": "The title of issue/escalation - Summarizing the issue in one line"
113                },
114                "attachments": {
115                  "type": "array",
116                  "items": {
117                    "type": "object",
118                    "properties": {
119                      "display": {
120                        "type": "string",
121                        "description": "Display name of Attachment"
122                      },
123                      "type": {
124                        "type": "string",
125                        "description": "Type of attachment - image, shipment, file etc"
126                      },
127                      "value": {
128                        "type": "string",
129                        "description": "Attachment value. For image/file it'll be a url. For shipment it'll be a shipment ID"
130                      }
131                    }
132                  }
133                },
134                "description": {
135                  "type": "string",
136                  "description": "The detailed description of issue/escalation - Encoded in base64"
137                },
138                "items": {
139                  "type": "string"
140                }
141              }
142            },
143            "category": {
144              "type": "string",
145              "description": "The category or category hierarchy for which the ticket is raised, e.g. Catalogue, Collection, Product, Logistics, etc."
146            },
147            "sla": {
148              "type": "object",
149              "description": "Details regarding the resolution time of a ticket",
150              "properties": {
151                "resolution_time": {
152                  "type": "string",
153                  "description": "Timestamp by which the ticket will be resolved"
154                }
155              }
156            },
157            "created_at": {
158              "type": "string",
159              "description": "Ticket creation time"
160            },
161            "created_by": {
162              "type": "object",
163              "description": "Contains description of user who created the ticket",
164              "required": [
165                "_id"
166              ],
167              "properties": {
168                "_id": {
169                  "type": "string",
170                  "description": "Unique Identifier for an user - auto generated by system"
171                },
172                "last_name": {
173                  "type": "string",
174                  "description": "Last name of the user who created the ticket"
175                },
176                "first_name": {
177                  "type": "string",
178                  "description": "Last name of the user who created the ticket"
179                }
180              }
181            },
182            "updated_at": {
183              "type": "string",
184              "description": "Ticket last updation time"
185            },
186            "priority": {
187              "type": "string",
188              "description": "Priority of the ticket - high, medium, low, urgent",
189              "enum": [
190                "high",
191                "low",
192                "medium",
193                "urgent"
194              ]
195            }
196          }
197        },
198        "type": {
199          "type": "string",
200          "description": "Type of event."
201        }
202      }
203    }
204  }
205}

1{
2  "event": {
3    "trace_id": [
4      "highbrow.afa35ff1-13d7-47ff-ac07-f95e76d551b6"
5    ],
6    "name": "support-ticket",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712147922314,
10    "id": "MRQ57aTXTvtPMyIkbLr1a4BpOu9LxH0KpRx2IF2uOo0=",
11    "category": "company"
12  },
13  "company_id": 46,
14  "contains": [
15    "ticket",
16    "type"
17  ],
18  "payload": {
19    "ticket": {
20      "_id": "660d4dd1a6c805c20b4c3352",
21      "source": "platform_panel",
22      "content": {
23        "title": "Ticket no 712147594320 / cX IS WAITING FOR PRODUCT, Bag ID 33849314 / Hamleys",
24        "description": "PHA+SGkgVGVhbSw8L3A+CjxwPkN4IGhhcyBwbGFjZWQgdGhlIG9yZGVyIG9uIDMwLTAzLTIwMjQgYnV0IHN0aWxsIHRoZSBvcmRlciBpcyBub3QgY29uZmlybWVkLjwvcD4KPHA+Q3ggaXMgd2FpdGluZyBmb3IgdGhlIHByb2R1Y3QgdG8gYmUgZGVsaXZlcmVkIG9uIHVyZ2VudCBiYXNlcy48L3A+CjxwPlNvIHdlIHJlcXVlc3QgeW91IHRvIHBsZWFzZSBkZWxpdmVyZWQgdGhlIHByb2R1Y3QgYXNhcC48L3A+",
25        "attachments": []
26      },
27      "tags": [
28        "Synced to Freshdesk"
29      ],
30      "category": "logistics > delivery_related > no_movement",
31      "priority": "high",
32      "status": "open",
33      "sla": {
34        "resolution_time": "2024-06-24T06:31:37.986Z"
35      },
36      "created_at": "2024-04-03T12:38:41.966Z",
37      "updated_at": "2024-04-03T12:38:41.966Z",
38      "created_by": {
39        "_id": "e2a288694429d6034e730874",
40        "first_name": "test",
41        "last_name": "test"
42      }
43    },
44    "type": "create"
45  }
46}

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        "ticket"
70      ],
71      "properties": {
72        "ticket": {
73          "type": "object",
74          "description": "The support ticket object associated with the event",
75          "required": [
76            "_id",
77            "content",
78            "category",
79            "status",
80            "priority"
81          ],
82          "properties": {
83            "_id": {
84              "type": "string",
85              "description": "Primary Identifier used for retrieving and updating the ticket"
86            },
87            "tags": {
88              "type": "array",
89              "description": "Array of string describing relevant tags to the ticket",
90              "items": {
91                "type": "string"
92              }
93            },
94            "source": {
95              "type": "string",
96              "description": "The type of origin of ticket - It can be either raised at platfom panel, partner panel or sales channel"
97            },
98            "status": {
99              "type": "string",
100              "description": "Describes the status of the ticket. Possible values: open, pending, in_progress, resolved, closed"
101            },
102            "content": {
103              "type": "object",
104              "description": "Contains title, base 64 encoded description (HTML), and list of attachments",
105              "required": [
106                "title",
107                "description"
108              ],
109              "properties": {
110                "title": {
111                  "type": "string",
112                  "description": "The title of issue/escalation - Summarizing the issue in one line"
113                },
114                "attachments": {
115                  "type": "array",
116                  "items": {
117                    "type": "object",
118                    "properties": {
119                      "display": {
120                        "type": "string",
121                        "description": "Display name of Attachment"
122                      },
123                      "type": {
124                        "type": "string",
125                        "description": "Type of attachment - image, shipment, file etc"
126                      },
127                      "value": {
128                        "type": "string",
129                        "description": "Attachment value. For image/file it'll be a url. For shipment it'll be a shipment ID"
130                      }
131                    }
132                  }
133                },
134                "description": {
135                  "type": "string",
136                  "description": "The detailed description of issue/escalation - Encoded in base64"
137                }
138              }
139            },
140            "category": {
141              "type": "string",
142              "description": "The category or category hierarchy for which the ticket is raised, e.g. Catalogue, Collection, Product, Logistics, etc."
143            },
144            "sla": {
145              "type": "object",
146              "description": "Details regarding the resolution time of a ticket",
147              "properties": {
148                "resolution_time": {
149                  "type": "string",
150                  "description": "Timestamp by which the ticket will be resolved"
151                }
152              }
153            },
154            "created_at": {
155              "type": "string",
156              "description": "Ticket creation time"
157            },
158            "created_by": {
159              "type": "object",
160              "description": "Contains description of user who created the ticket",
161              "required": [
162                "_id"
163              ],
164              "properties": {
165                "_id": {
166                  "type": "string",
167                  "description": "Unique Identifier for an user - auto generated by system"
168                },
169                "last_name": {
170                  "type": "string",
171                  "description": "Last name of the user who created the ticket"
172                },
173                "first_name": {
174                  "type": "string",
175                  "description": "Last name of the user who created the ticket"
176                }
177              }
178            },
179            "updated_at": {
180              "type": "string",
181              "description": "Ticket last updation time"
182            },
183            "priority": {
184              "type": "string",
185              "description": "Priority of the ticket - high, medium, low, urgent",
186              "enum": [
187                "high",
188                "low",
189                "medium",
190                "urgent"
191              ]
192            }
193          }
194        },
195        "type": {
196          "type": "string",
197          "description": "Type of event."
198        }
199      }
200    }
201  }
202}

1{
2  "event": {
3    "trace_id": [
4      "highbrow.4d0532eb-9212-4c8a-b7fe-ed82cf63383b"
5    ],
6    "name": "support-ticket",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712124739528,
10    "id": "ToQCu76QZV2EF1q++HZjOTHluZ3fDLogpmQNYaAx4LE=",
11    "category": "company"
12  },
13  "company_id": 320,
14  "contains": [
15    "ticket",
16    "type"
17  ],
18  "payload": {
19    "ticket": {
20      "_id": "660cf31ca6c805c20b494fb5",
21      "source": "platform_panel",
22      "content": {
23        "title": "Locked",
24        "description": "PHA+U0xBIGJyZWFjaGVkPC9wPg==",
25        "attachments": []
26      },
27      "tags": [
28        "Synced to Freshdesk"
29      ],
30      "category": "sales_channel > 3p_marketplace",
31      "priority": "urgent",
32      "status": "open",
33      "sla": {
34        "resolution_time": "2024-06-24T06:31:37.986Z"
35      },
36      "created_at": "2024-04-03T06:11:40.232Z",
37      "updated_at": "2024-04-03T06:11:58.566Z",
38      "created_by": {
39        "_id": "3794679420adfa2473997b6a",
40        "first_name": "test",
41        "last_name": "V"
42      }
43    },
44    "type": "update"
45  }
46}