Company
Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.
This event will be generated where there is any action done on customfield_definition
Events
company/customfield_definition/create/v1
# This event is triggered when a customfield definition is created
company/customfield_definition/update/v1
# This event is triggered when a customfield definition is updated
company/customfield_definition/delete/v1
# This event is triggered when a customfield definition is deleted
Payload
Hide
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 ],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 "properties": {69 "slug": {70 "type": "string",71 "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."72 },73 "namespace": {74 "type": "string",75 "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."76 },77 "name": {78 "type": "string",79 "description": "Name of the custom fields. Its editable."80 },81 "description": {82 "type": "string",83 "description": "This is description about the custom field definition."84 },85 "id": {86 "type": "string",87 "description": "Uniquely generated mongoId of custom field definition and its not editable."88 },89 "type": {90 "type": "string",91 "description": "This is field_type of the custom field definition. Its non-editable"92 },93 "is_deleted": {94 "type": "boolean",95 "description": "This indicates that this custom fields definition is deleted or not."96 },97 "validations": {98 "type": "array",99 "items": {},100 "description": "Validations array have supported validations for the custom field definition"101 },102 "multi_value": {103 "type": "boolean",104 "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."105 },106 "resource": {107 "type": "string",108 "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"109 },110 "company_id": {111 "type": "string",112 "description": "This is company id where this custom fields created."113 },114 "updated_by": {115 "type": "string",116 "description": "The last user that edited this definition"117 },118 "required": {119 "type": "boolean",120 "description": "This indicates whether the field is required or not"121 }122 },123 "required": [124 "slug",125 "namespace",126 "name",127 "type",128 "id",129 "multi_value",130 "resource",131 "company_id"132 ]133 }134 }135}
Payload Example
1{2 "event": {3 "trace_id": [4 "convex.d1c35cc8-57b7-43a6-9453-0129ab7242c0"5 ],6 "name": "customfield_definition",7 "type": "create",8 "version": "1",9 "created_timestamp": 1712488632605,10 "id": "dysGEBnlnRD6purMmL9tCi5ZN4Y78kjBxb7PUjN3O+o=",11 "category": "company",12 "referer": "fyndx1.de"13 },14 "company_id": 26518,15 "contains": [16 "resource",17 "name",18 "namespace",19 "description",20 "slug",21 "type",22 "multi_value",23 "validations",24 "company_id",25 "required",26 "is_deleted",27 "id"28 ],29 "payload": {30 "resource": "product",31 "name": "pmwza",32 "namespace": "ajddn",33 "slug": "nfcnt",34 "description": "kndnetfqozowndcsnsqsedjln",35 "type": "string_single_line",36 "multi_value": false,37 "validations": [38 {39 "name": "min",40 "type": "integer",41 "value": 542 },43 {44 "name": "max",45 "type": "integer",46 "value": 647 }48 ],49 "company_id": "26518",50 "required": false,51 "is_deleted": false,52 "id": "661280b811eefc90fd21fbb5"53 }54}
Payload
Hide
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 ],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 "properties": {69 "slug": {70 "type": "string",71 "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."72 },73 "namespace": {74 "type": "string",75 "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."76 },77 "name": {78 "type": "string",79 "description": "Name of the custom fields. Its editable."80 },81 "description": {82 "type": "string",83 "description": "This is description about the custom field definition."84 },85 "id": {86 "type": "string",87 "description": "Uniquely generated mongoId of custom field definition and its not editable."88 },89 "type": {90 "type": "string",91 "description": "This is field_type of the custom field definition. Its non-editable"92 },93 "is_deleted": {94 "type": "boolean",95 "description": "This indicates that this custom fields definition is deleted or not."96 },97 "validations": {98 "type": "array",99 "items": {},100 "description": "Validations array have supported validations for the custom field definition"101 },102 "multi_value": {103 "type": "boolean",104 "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."105 },106 "resource": {107 "type": "string",108 "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"109 },110 "company_id": {111 "type": "string",112 "description": "This is company id where this custom fields created."113 },114 "required": {115 "type": "boolean",116 "description": "This indicates whether the field is required or not"117 }118 },119 "required": [120 "slug",121 "namespace",122 "name",123 "type",124 "id",125 "multi_value",126 "resource",127 "company_id"128 ]129 }130 }131}
Payload Example
1{2 "event": {3 "trace_id": [4 "convex.72bfcadf-a2f9-4aa8-9ebb-0e7dc0036520"5 ],6 "name": "customfield_definition",7 "type": "update",8 "version": "1",9 "created_timestamp": 1712488632881,10 "id": "bL8DS0iVxJAWexpE+BNCaSkhGFkmZzh/FsBHMbWl2Kw=",11 "category": "company",12 "referer": "fyndx1.de"13 },14 "company_id": 26518,15 "contains": [16 "id",17 "resource",18 "name",19 "namespace",20 "slug",21 "description",22 "type",23 "multi_value",24 "validations",25 "company_id",26 "required",27 "is_deleted"28 ],29 "payload": {30 "id": "661280b811eefc90fd21fbb5",31 "resource": "product",32 "name": "sicoenvqeu",33 "namespace": "ajddn",34 "slug": "nfcnt",35 "description": "ljicgwvaypelmjhmjomhuwvzf",36 "type": "string_single_line",37 "multi_value": false,38 "validations": [39 {40 "name": "min",41 "type": "integer",42 "value": 543 },44 {45 "name": "max",46 "type": "integer",47 "value": 648 }49 ],50 "company_id": "26518",51 "required": false,52 "is_deleted": false53 }54}
Payload
Hide
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 ],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 "properties": {69 "slug": {70 "type": "string",71 "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."72 },73 "namespace": {74 "type": "string",75 "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."76 },77 "name": {78 "type": "string",79 "description": "Name of the custom fields. Its editable."80 },81 "description": {82 "type": "string",83 "description": "This is description about the custom field definition."84 },85 "id": {86 "type": "string",87 "description": "Uniquely generated mongoId of custom field definition and its not editable."88 },89 "type": {90 "type": "string",91 "description": "This is field_type of the custom field definition. Its non-editable"92 },93 "is_deleted": {94 "type": "boolean",95 "description": "This indicates that this custom fields definition is deleted or not."96 },97 "validations": {98 "type": "array",99 "items": {},100 "description": "Validations array have supported validations for the custom field definition"101 },102 "multi_value": {103 "type": "boolean",104 "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."105 },106 "resource": {107 "type": "string",108 "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"109 },110 "company_id": {111 "type": "string",112 "description": "This is company id where this custom fields created."113 },114 "required": {115 "type": "boolean",116 "description": "This indicates whether the field is required or not"117 }118 },119 "required": [120 "slug",121 "namespace",122 "name",123 "type",124 "id",125 "is_deleted",126 "multi_value",127 "resource",128 "company_id"129 ]130 }131 }132}
Payload Example
1{2 "event": {3 "trace_id": [4 "convex.61dece8c-e8c9-43d0-af29-5d1d3daeef2c"5 ],6 "name": "customfield_definition",7 "type": "delete",8 "version": "1",9 "created_timestamp": 1712488634113,10 "id": "+puowDa2Lp6dTntMMjNw4PUBKpJ4FsmynQEYporGxbY=",11 "category": "company",12 "referer": "fyndx1.de"13 },14 "company_id": 26518,15 "contains": [16 "id",17 "resource",18 "name",19 "namespace",20 "slug",21 "description",22 "type",23 "multi_value",24 "validations",25 "company_id",26 "required",27 "is_deleted"28 ],29 "payload": {30 "id": "661280b811eefc90fd21fbb5",31 "resource": "product",32 "name": "sicoenvqeu",33 "namespace": "ajddn",34 "slug": "nfcnt",35 "description": "ljicgwvaypelmjhmjomhuwvzf",36 "type": "string_single_line",37 "multi_value": false,38 "validations": [39 {40 "name": "min",41 "type": "integer",42 "value": 543 },44 {45 "name": "max",46 "type": "integer",47 "value": 648 }49 ],50 "company_id": "26518",51 "required": false,52 "is_deleted": true53 }54}