Global

Events categorised under global level will be triggered when any action performed for all companies. e.g. If new department is created.

Department

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

Events

global/department/create/v1

# this event is triggered when department is created

global/department/update/v1

# this event is triggered when department is updated

Department/department/create/v1

this event is triggered when department is created

Payload

Properties

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

department

object

Required

Department information

Properties

uid

integer

Required

The unique ID for the department

logo

string

Required

The URL of the department's logo

priority_order

integer

Required

The priority order of the department

name

string

Required

The name of the department

slug

string

Required

The unique slug identifier for the department

_id

string

Required

ID of the department

is_active

boolean

Status of the department

synonyms

array of string

List of synonyms for the department

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "contains",
5    "event",
6    "payload"
7  ],
8  "properties": {
9    "contains": {
10      "type": "array",
11      "description": "This array will have all the keys present at root level of 'payload' object",
12      "items": {
13        "type": "string"
14      }
15    },
16    "event": {
17      "type": "object",
18      "required": [
19        "category",
20        "created_timestamp",
21        "id",
22        "name",
23        "trace_id",
24        "type",
25        "version"
26      ],
27      "properties": {
28        "category": {
29          "type": "string",
30          "description": "category of the event. If it is at sales channel level or company level"
31        },
32        "created_timestamp": {
33          "type": "integer",
34          "description": "event generation timestamp in epoch milliseconds"
35        },
36        "id": {
37          "type": "string",
38          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
39        },
40        "name": {
41          "type": "string",
42          "description": "Name of the event"
43        },
44        "trace_id": {
45          "type": "array",
46          "description": "internal trace_id for Fynd Platform services",
47          "items": {
48            "type": "string"
49          }
50        },
51        "type": {
52          "type": "string",
53          "description": "Type/Action of the event. e.g. create/update/delete"
54        },
55        "version": {
56          "type": "string",
57          "description": "Version of the event."
58        }
59      }
60    },
61    "payload": {
62      "type": "object",
63      "properties": {
64        "department": {
65          "type": "object",
66          "properties": {
67            "uid": {
68              "type": "integer",
69              "description": "The unique ID for the department"
70            },
71            "logo": {
72              "type": "string",
73              "description": "The URL of the department's logo"
74            },
75            "priority_order": {
76              "type": "integer",
77              "description": "The priority order of the department"
78            },
79            "name": {
80              "type": "string",
81              "description": "The name of the department"
82            },
83            "slug": {
84              "type": "string",
85              "description": "The unique slug identifier for the department"
86            },
87            "_id": {
88              "type": "string",
89              "description": "ID of the department"
90            },
91            "is_active": {
92              "type": "boolean",
93              "description": "Status of the department"
94            },
95            "synonyms": {
96              "type": "array",
97              "description": "List of synonyms for the department",
98              "items": {
99                "type": "string"
100              }
101            }
102          },
103          "required": [
104            "uid",
105            "logo",
106            "priority_order",
107            "name",
108            "slug",
109            "_id"
110          ],
111          "description": "Department information"
112        }
113      },
114      "required": [
115        "department"
116      ]
117    }
118  }
119}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.e0fa5e4e-ef24-11ee-ae3f-46bbe8baa09d"
5    ],
6    "name": "department",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711865216742,
10    "id": "n6NUprbxJoXsGxeP69kZZSOVgu+2iO6KctMgIkU5V2o=",
11    "category": "global"
12  },
13  "contains": [
14    "department"
15  ],
16  "payload": {
17    "department": {
18      "name": "Home",
19      "uid": 34,
20      "slug": "home",
21      "_id": "6608fd802850d27555189d1d",
22      "priority_order": 10,
23      "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/eeken/E1113PP01A002_OGN/0/Ym43PKxyKe-e1113pp01a002_ogn_1.jpg"
24    }
25  }
26}

Department/department/update/v1

this event is triggered when department is updated

Payload

Properties

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

department

object

Required

Department information

Properties

uid

integer

Required

The unique ID for the department

logo

string

Required

The URL of the department's logo

priority_order

integer

Required

The priority order of the department

name

string

Required

The name of the department

slug

string

The unique slug identifier for the department

_id

string

ID of the department

is_active

boolean

Status of the department

synonyms

array of string

List of synonyms for the department

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "contains",
5    "event",
6    "payload"
7  ],
8  "properties": {
9    "contains": {
10      "type": "array",
11      "description": "This array will have all the keys present at root level of 'payload' object",
12      "items": {
13        "type": "string"
14      }
15    },
16    "event": {
17      "type": "object",
18      "required": [
19        "category",
20        "created_timestamp",
21        "id",
22        "name",
23        "trace_id",
24        "type",
25        "version"
26      ],
27      "properties": {
28        "category": {
29          "type": "string",
30          "description": "category of the event. If it is at sales channel level or company level"
31        },
32        "created_timestamp": {
33          "type": "integer",
34          "description": "event generation timestamp in epoch milliseconds"
35        },
36        "id": {
37          "type": "string",
38          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
39        },
40        "name": {
41          "type": "string",
42          "description": "Name of the event"
43        },
44        "trace_id": {
45          "type": "array",
46          "description": "internal trace_id for Fynd Platform services",
47          "items": {
48            "type": "string"
49          }
50        },
51        "type": {
52          "type": "string",
53          "description": "Type/Action of the event. e.g. create/update/delete"
54        },
55        "version": {
56          "type": "string",
57          "description": "Version of the event."
58        }
59      }
60    },
61    "payload": {
62      "type": "object",
63      "properties": {
64        "department": {
65          "type": "object",
66          "properties": {
67            "uid": {
68              "type": "integer",
69              "description": "The unique ID for the department"
70            },
71            "logo": {
72              "type": "string",
73              "description": "The URL of the department's logo"
74            },
75            "priority_order": {
76              "type": "integer",
77              "description": "The priority order of the department"
78            },
79            "name": {
80              "type": "string",
81              "description": "The name of the department"
82            },
83            "slug": {
84              "type": "string",
85              "description": "The unique slug identifier for the department"
86            },
87            "_id": {
88              "type": "string",
89              "description": "ID of the department"
90            },
91            "is_active": {
92              "type": "boolean",
93              "description": "Status of the department"
94            },
95            "synonyms": {
96              "type": "array",
97              "description": "List of synonyms for the department",
98              "items": {
99                "type": "string"
100              }
101            }
102          },
103          "required": [
104            "uid",
105            "logo",
106            "priority_order",
107            "name"
108          ],
109          "description": "Department information"
110        }
111      },
112      "required": [
113        "department"
114      ]
115    }
116  }
117}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "silverbolt.b7a42bfe-f296-11ee-a49f-fafdf6ca3f64"
5    ],
6    "name": "department",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712243963507,
10    "id": "yHeApfVnlSKHHgbrDbnP5KlCKMAwDrIYicEi07n7b9Y=",
11    "category": "global"
12  },
13  "contains": [
14    "department"
15  ],
16  "payload": {
17    "department": {
18      "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/test/general/free/original/sampleJPG.jpg",
19      "priority_order": 2,
20      "synonyms": [],
21      "is_active": false,
22      "name": "Test name - 1712243930641",
23      "uid": 60390
24    }
25  }
26}

« category/create/v1

extension/install/v1 »