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.

Customobject definition

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

Events

application/customobject_definition/create/v1

# This event is triggered when a customobject definition is created

application/customobject_definition/update/v1

# This event is triggered when a customobject definition is updated

application/customobject_definition/delete/v1

# This event is triggered when a customobject definition is deleted

Customobject Definition/customobject_definition/create/v1

This event is triggered when a customobject definition 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

string

Required

Uniquely generated id of custom object definition and its not editable.

name

string

Required

Name is use for the custom object definition name

slug

string

Required

A unique identifier for the custom object definition. Its required and will not be modified once created.

company_id

string

The id of the company where the field is created

application_id

string

The id of the application where the field is created

field_definitions

array of Undefined Type

Required

This indicates all the custom field definitions part of the custom object

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      "properties": {
77        "id": {
78          "type": "string",
79          "description": "Uniquely generated id of custom object definition and its not editable."
80        },
81        "name": {
82          "type": "string",
83          "description": "Name is use for the custom object definition name"
84        },
85        "slug": {
86          "type": "string",
87          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
88        },
89        "company_id": {
90          "type": "string",
91          "description": "The id of the company where the field is created"
92        },
93        "application_id": {
94          "type": "string",
95          "description": "The id of the application where the field is created"
96        },
97        "field_definitions": {
98          "type": "array",
99          "description": "This indicates all the custom field definitions part of the custom object",
100          "items": [
101            {
102              "type": "object",
103              "properties": {
104                "resource": {
105                  "type": "string",
106                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
107                },
108                "name": {
109                  "type": "string",
110                  "description": "Name of the custom fields. Its editable."
111                },
112                "namespace": {
113                  "type": "string",
114                  "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
115                },
116                "slug": {
117                  "type": "string",
118                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
119                },
120                "type": {
121                  "type": "string",
122                  "description": "This is field_type of the custom field definition. Its non-editable"
123                },
124                "multi_value": {
125                  "type": "boolean",
126                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
127                },
128                "company_id": {
129                  "type": "string",
130                  "description": "This is company id where this custom fields created."
131                },
132                "application_id": {
133                  "type": "string",
134                  "description": "This is application id where this custom fields created."
135                },
136                "required": {
137                  "type": "boolean",
138                  "description": "This indicates whether the field is required or not"
139                },
140                "is_deleted": {
141                  "type": "boolean",
142                  "description": "This indicates that this custom fields definition is deleted or not."
143                }
144              },
145              "required": [
146                "resource",
147                "name",
148                "slug",
149                "type",
150                "company_id",
151                "application_id"
152              ]
153            }
154          ]
155        }
156      },
157      "required": [
158        "id",
159        "name",
160        "slug",
161        "field_definitions"
162      ]
163    }
164  }
165}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.15001f29-4fdb-4e2e-aa60-14613bc5d2f5"
5    ],
6    "name": "customobject_definition",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711213321865,
10    "id": "4kOMIhI2F3rqDMbMxSf+nl3gwtGcfZFW5H5HXGPRy7k=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "name",
19    "type",
20    "description",
21    "company_id",
22    "application_id",
23    "field_definitions"
24  ],
25  "payload": {
26    "id": "65ff0b09cd286b467dcae289",
27    "name": "kafka app test object",
28    "type": "kafka-app-test-object",
29    "slug": "kafka-app-test-object",
30    "description": "kafka app test object",
31    "company_id": "1",
32    "application_id": "64c00b72c07acacc1357503b",
33    "field_definitions": [
34      {
35        "resource": "metaobject",
36        "name": "kafka app test object single",
37        "namespace": "kafka-app-test-object",
38        "key": "kafka-app-test-object-single",
39        "slug": "kafka-app-test-object-single",
40        "description": "",
41        "type": "string_single_line",
42        "multi_value": true,
43        "validations": [],
44        "company_id": "1",
45        "application_id": "64c00b72c07acacc1357503b",
46        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
47        "required": true,
48        "is_deleted": false,
49        "id": "65ff0b09cd286b467dcae28c"
50      },
51      {
52        "resource": "metaobject",
53        "name": "kafka app test object multi",
54        "namespace": "kafka-app-test-object",
55        "key": "kafka-app-test-object-multi",
56        "slug": "kafka-app-test-object-multi",
57        "description": "",
58        "type": "string_multi_line",
59        "multi_value": true,
60        "validations": [],
61        "company_id": "1",
62        "application_id": "64c00b72c07acacc1357503b",
63        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
64        "required": true,
65        "is_deleted": false,
66        "id": "65ff0b09cd286b467dcae28d"
67      }
68    ]
69  }
70}

Customobject Definition/customobject_definition/update/v1

This event is triggered when a customobject definition 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

string

Required

Uniquely generated id of custom object definition and its not editable.

name

string

Required

Name is use for the custom object definition name

slug

string

Required

A unique identifier for the custom object definition. Its required and will not be modified once created.

company_id

string

The id of the company where the field is created

application_id

string

The id of the application where the field is created

field_definitions

array of Undefined Type

Required

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      "properties": {
77        "id": {
78          "type": "string",
79          "description": "Uniquely generated id of custom object definition and its not editable."
80        },
81        "name": {
82          "type": "string",
83          "description": "Name is use for the custom object definition name"
84        },
85        "slug": {
86          "type": "string",
87          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
88        },
89        "company_id": {
90          "type": "string",
91          "description": "The id of the company where the field is created"
92        },
93        "application_id": {
94          "type": "string",
95          "description": "The id of the application where the field is created"
96        },
97        "field_definitions": {
98          "type": "array",
99          "items": [
100            {
101              "type": "object",
102              "properties": {
103                "resource": {
104                  "type": "string",
105                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
106                },
107                "name": {
108                  "type": "string",
109                  "description": "Name of the custom fields. Its editable."
110                },
111                "namespace": {
112                  "type": "string",
113                  "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
114                },
115                "slug": {
116                  "type": "string",
117                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
118                },
119                "type": {
120                  "type": "string",
121                  "description": "This is field_type of the custom field definition. Its non-editable"
122                },
123                "multi_value": {
124                  "type": "boolean",
125                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
126                },
127                "company_id": {
128                  "type": "string",
129                  "description": "This is company id where this custom fields created."
130                },
131                "application_id": {
132                  "type": "string",
133                  "description": "The id of the application where this application is created"
134                },
135                "required": {
136                  "type": "boolean",
137                  "description": "This indicates whether the field is required or not"
138                },
139                "is_deleted": {
140                  "type": "boolean",
141                  "description": "This indicates that this custom fields definition is deleted or not."
142                }
143              },
144              "required": [
145                "resource",
146                "name",
147                "slug",
148                "type",
149                "company_id",
150                "application_id"
151              ]
152            }
153          ]
154        }
155      },
156      "required": [
157        "id",
158        "name",
159        "slug",
160        "field_definitions"
161      ]
162    }
163  }
164}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.79b4625e-928c-4c4c-ab6d-4bcc9e0f3dc6"
5    ],
6    "name": "customobject_definition",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711213382773,
10    "id": "vEKqvVohprDpJL1XjrQ59QM7iodqCbJcZO6/dO+LpCI=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "name",
19    "slug",
20    "description",
21    "company_id",
22    "application_id",
23    "field_definitions"
24  ],
25  "payload": {
26    "id": "65ff0b09cd286b467dcae289",
27    "name": "kafka app test object edited",
28    "slug": "kafka-app-test-object",
29    "description": "kafka app test object",
30    "company_id": "1",
31    "application_id": "64c00b72c07acacc1357503b",
32    "field_definitions": [
33      {
34        "resource": "metaobject",
35        "name": "kafka app test object multi",
36        "namespace": "kafka-app-test-object",
37        "slug": "kafka-app-test-object-multi",
38        "type": "string_multi_line",
39        "description": "",
40        "multi_value": true,
41        "validations": [],
42        "company_id": "1",
43        "application_id": "64c00b72c07acacc1357503b",
44        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
45        "required": true
46      },
47      {
48        "resource": "metaobject",
49        "name": "kafka app test object single",
50        "namespace": "kafka-app-test-object",
51        "slug": "kafka-app-test-object-single",
52        "type": "string_single_line",
53        "description": "",
54        "multi_value": true,
55        "validations": [],
56        "company_id": "1",
57        "application_id": "64c00b72c07acacc1357503b",
58        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
59        "required": true
60      }
61    ]
62  }
63}

Customobject Definition/customobject_definition/delete/v1

This event is triggered when a customobject definition 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

string

Required

Uniquely generated id of custom object definition and its not editable.

name

string

Required

Name is use for the custom object definition name

slug

string

Required

A unique identifier for the custom object definition. Its required and will not be modified once created.

company_id

string

The id of the company where the field is created

application_id

string

The id of the application where the field is created

field_definitions

array of Undefined Type

Required

This indicates all the custom field definitions part of the custom object

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      "properties": {
77        "id": {
78          "type": "string",
79          "description": "Uniquely generated id of custom object definition and its not editable."
80        },
81        "name": {
82          "type": "string",
83          "description": "Name is use for the custom object definition name"
84        },
85        "slug": {
86          "type": "string",
87          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
88        },
89        "company_id": {
90          "type": "string",
91          "description": "The id of the company where the field is created"
92        },
93        "application_id": {
94          "type": "string",
95          "description": "The id of the application where the field is created"
96        },
97        "field_definitions": {
98          "type": "array",
99          "description": "This indicates all the custom field definitions part of the custom object",
100          "items": [
101            {
102              "type": "object",
103              "properties": {
104                "resource": {
105                  "type": "string",
106                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
107                },
108                "name": {
109                  "type": "string",
110                  "description": "Name of the custom fields. Its editable."
111                },
112                "namespace": {
113                  "type": "string",
114                  "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
115                },
116                "slug": {
117                  "type": "string",
118                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
119                },
120                "type": {
121                  "type": "string",
122                  "description": "This is field_type of the custom field definition. Its non-editable"
123                },
124                "multi_value": {
125                  "type": "boolean",
126                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
127                },
128                "company_id": {
129                  "type": "string",
130                  "description": "This is company id where this custom fields created."
131                },
132                "application_id": {
133                  "type": "string",
134                  "description": "This is application id where this custom fields created."
135                },
136                "required": {
137                  "type": "boolean",
138                  "description": "This indicates whether the field is required or not"
139                },
140                "is_deleted": {
141                  "type": "boolean",
142                  "description": "This indicates that this custom fields definition is deleted or not."
143                }
144              },
145              "required": [
146                "resource",
147                "name",
148                "slug",
149                "type",
150                "company_id",
151                "application_id"
152              ]
153            }
154          ]
155        }
156      },
157      "required": [
158        "id",
159        "name",
160        "slug",
161        "field_definitions"
162      ]
163    }
164  }
165}

Payload Example

1{
2  "event": {
3    "trace_id": [
4      "convex.362874f3-39f9-4559-af45-777a63cba3bb"
5    ],
6    "name": "customobject_definition",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1711213534784,
10    "id": "1cnMyJ8SM+swoNSF3LAMAPwQIVJLsNoV5j3QJDkqAqA=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "name",
19    "slug",
20    "description",
21    "company_id",
22    "application_id",
23    "display_name_key",
24    "field_definitions",
25    "is_deleted"
26  ],
27  "payload": {
28    "id": "65ff0b09cd286b467dcae289",
29    "name": "kafka app test object edited",
30    "slug": "kafka-app-test-object",
31    "description": "kafka app test object",
32    "company_id": "1",
33    "application_id": "64c00b72c07acacc1357503b",
34    "display_name_key": "",
35    "field_definitions": [
36      {
37        "id": "65ff0b09cd286b467dcae28d",
38        "resource": "metaobject",
39        "name": "kafka app test object multi",
40        "namespace": "kafka-app-test-object",
41        "slug": "kafka-app-test-object-multi",
42        "description": "",
43        "type": "string_multi_line",
44        "multi_value": true,
45        "validations": [],
46        "company_id": "1",
47        "application_id": "64c00b72c07acacc1357503b",
48        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
49        "required": true,
50        "is_deleted": false
51      },
52      {
53        "id": "65ff0b09cd286b467dcae28c",
54        "resource": "metaobject",
55        "name": "kafka app test object single",
56        "namespace": "kafka-app-test-object",
57        "slug": "kafka-app-test-object-single",
58        "description": "",
59        "type": "string_single_line",
60        "multi_value": true,
61        "validations": [],
62        "company_id": "1",
63        "application_id": "64c00b72c07acacc1357503b",
64        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
65        "required": true,
66        "is_deleted": false
67      }
68    ],
69    "is_deleted": true
70  }
71}

« customfields/bag-update/v1

customobjects/create/v1 »