Get Org Events

Retrieves all events configured for the org. This includes both standard and custom events.

API endpoint example

`http://eu.api.capillarytech.com/v2/events'

Prerequisites

  • Authentication: Basic or OAuth credentials
  • Access group resource: Read access on Behavioural Events resource

Resource information

URI/v2/events
HTTP MethodGET
PaginationNo
Batch supportNo
Rate limit informationNA

Request payload

curl --location 'http://eu.api.capillarytech.com/v2/events' \
--header 'Authorization: Basic VzdWNlRkYg==' \
--header 'Cookie: _cfuvid=cVUZ35z5krdCM26evqA.B0plrMHwkF57TihY2N7Cp0k-1718948790910-0.0.1.1-604800000'

Response parameters

ParameterData TypeDescription
dataArray of ObjectsObject containing event metadata and field mapping information.
- clickEventsMetaObjectObject containing metadata related to the event.
-- eventIdStringUnique identifier generated for the event at the time of its creation.
-- eventNameStringName of the event.
-- actionsObjectObject containing a list of event handlers that process the event.
-- fieldsArray of ObjectsObject containing the details of the fields of the event.
--- nameStringName of the field.
--- typeStringData type or data related to the field. Example: STRING, DOUBLE, CUSTOMER
--- attributesObjectAttributes associated with the field.
---- accountIdObjectObject containing customer account-related information for the field.
----- valueTypeStringData type of the value of accountId.
---- addCustomerIfNotExistsObjectObject containing information for adding customers if they do not exist.
----- valueBooleanSpecifies if customers should be added if they do not exist.
Values: True - If customers do not exist, they should be created.
False - If customers do not exist, they should not be created.
----- valueTypeStringIndicates the data type of the value of addCustomerIfNotExists.
---- identifierTypeObjectContains information on customer identifier type.
----- valueStringCustomer identifier name.
----- valueTypeStringData type of the value of identifierType.
---- isRequiredObjectObject containing information on whether the field is mandatory.
----- valueBooleanValue indicating if the field is mandatory. Values: True - mandatory, False - not mandatory.
----- valueTypeStringData type of the value of isRequired.
---- sourceObjectContains information on the source of customer creation .
----- valueStringSource of customer creation.
----- valueTypeStringDatatype of the value of source.
---- isPsiDataObjectObject indicating if the field contains Protected Sensitive Information. For more information refer, Classify Potentially Sensitive Information (PSI)
----- valueBooleanValue indicating if Protected Sensitive Information is present. Values: True - PSI present, False - No PSI.
----- valueTypeStringDataype of the value of isPsiData.
---- regexObjectObject containing information for regex.
----- valueTypeStringDatatype of the value of regex.
-- orgIdIntegerOrganisation ID for which the events are created.
-- statusStringIndicates if the event is published.
-- testStatusStringIndicates if the event is verified for data flow.
-- labelStringDisplay name of the event.
-- descriptionStringDescription of the event.
-- dateIntegerTimestamp for the event in UNIX epoch format.
-- standardEventBooleanIndicates if the event is standard or custom. A value of true indicates it is a standard event, while false indicates it is a custom event.
- transformerMappingsObjectObject containing information on field mapping. For more information see, Transformer.
-- defaultTransformerMappingObjectObject containing information on default field mapping.
--- eventNameMappingObjectObject containing information on mapping the event name.
---- valueMapObjectObject containing the event name for mapping.
--- eventFieldMappingsArray of ObjectsObject containing information on the mapping of the event's fields.
---- eventFieldNameStringName of the field for the event.
---- fieldNameStringValue the field is mapped to.
-- webEngageTransformerMappingObjectObject containing information on mapping for WebEngage. For more information see, WebEngage.
--- eventNameMappingObjectObject containing information on mapping the event name.
---- valueMapObjectObject containing the event name for mapping.
--- eventFieldMappingsArray of ObjectsObject containing information on the mapping of the event's fields.
---- eventFieldNameStringName of the field for the event.
---- fieldNameStringValue the field is mapped to.
warningsObjectObject containing a list of warning messages, if any.
errorsObjectObject containing a list of error messages, if any.

{
    "data": [
        {
            "clickEventsMeta": {
                "eventId": "e5e99bc08aa62321978661fea1d750c4",
                "eventName": "Testing_3",
                "eventType": "USEREVENT",
                "actions": [
                    "EIConsumer"
                ],
                "fields": [
                    {
                        "name": "userId",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "userId",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "deviceId",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    },
                    {
                        "name": "Testing_3",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "UNPUBLISHED",
                "testStatus": "NOT_VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "Testing_3",
                "description": "subscribe a Channel",
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "a927234bff097b96f55d76af894d9268",
                "eventName": "TestEventWithDate",
                "eventType": "USEREVENT",
                "actions": [
                    "EMFConsumer",
                    "EIConsumer"
                ],
                "fields": [
                    {
                        "name": "CustomerId",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "mobile",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "createdDate",
                        "type": "DATE",
                        "attributes": {
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "Date Event",
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "98ed645f4af37c8e78f730ff05693de8",
                "eventName": "Testing_2",
                "eventType": "USEREVENT",
                "actions": [
                    "EIConsumer"
                ],
                "fields": [
                    {
                        "name": "userId",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "userId",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "deviceId",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    },
                    {
                        "name": "Testing_2",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "UNPUBLISHED",
                "testStatus": "NOT_VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "Testing_1",
                "description": "Unsubscribe a Channel",
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "eeecd8aa478ec24f5477fdadbaa20c1b",
                "eventName": "UCCtesttarget3",
                "eventType": "USEREVENT",
                "actions": [
                    "EMFConsumer",
                    "EIConsumer"
                ],
                "fields": [
                    {
                        "name": "userID",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "mobile",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "points",
                        "type": "DOUBLE",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "UCCtesttarget3",
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "cda868ab8e45f92627424685fc9aa419",
                "eventName": "UCCtesttarget2",
                "actions": [
                    "EIConsumer",
                    "EMFConsumer"
                ],
                "fields": [
                    {
                        "name": "userId",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "userId",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "deviceId",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    },
                    {
                        "name": "UCCtesttarget2",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    },
                    {
                        "name": "points",
                        "type": "DOUBLE",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "UNPUBLISHED",
                "testStatus": "NOT_VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "UCCtesttarget2",
                "description": "un/subscribe a Channel",
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "516f327076e55fcc52afb9592e3c8ffd",
                "eventName": "Testing_1",
                "actions": [
                    "EIConsumer",
                    "EMFConsumer"
                ],
                "fields": [
                    {
                        "name": "userId",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "userId",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "deviceId",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    },
                    {
                        "name": "eventTime",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "UNPUBLISHED",
                "testStatus": "NOT_VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "Testing_1",
                "description": "Unsubscribe a Channel",
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "6cb354c56da0d8fd555ea7296a173f69",
                "eventName": "TestBE-Rutuja",
                "actions": [
                    "EIConsumer",
                    "EMFConsumer"
                ],
                "fields": [
                    {
                        "name": "customer",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "false",
                                "valueType": "Boolean"
                            },
                            "identifierType": {
                                "value": "mobile",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "String",
                        "type": "TILLCODE",
                        "attributes": {
                            "isRequired": {
                                "value": "false",
                                "valueType": "Boolean"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "description": "This is a demo event created && updated by Rutuja Hatwar",
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "f7d31950cc2ef1fbb3c03af1b00207a1",
                "eventName": "Group_User_Event",
                "eventType": "USEREVENT",
                "actions": [
                    "EMFConsumer"
                ],
                "fields": [
                    {
                        "name": "customer",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "true",
                                "valueType": "Boolean"
                            },
                            "identifierType": {
                                "value": "mobile",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "String",
                        "type": "TILLCODE",
                        "attributes": {
                            "isRequired": {
                                "value": "false",
                                "valueType": "Boolean"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "enum",
                        "type": "GROUPID",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "groupIdentifierType": {
                                "value": "GroupExternalId",
                                "valueType": "ENUM"
                            },
                            "identifierType": {
                                "value": "userId",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "Boolean"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "8dc87bcc1a938e5196f0f69b3a6f4ba4",
                "eventName": "DemoTest20250428",
                "eventType": "PRODUCTEVENT",
                "actions": [
                    "EMFConsumer"
                ],
                "fields": [
                    {
                        "name": "customer",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "true",
                                "valueType": "Boolean"
                            },
                            "identifierType": {
                                "value": "mobile",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "rutuja_capillary",
                        "type": "TILLCODE",
                        "attributes": {
                            "isRequired": {
                                "value": "true",
                                "valueType": "Boolean"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "sku",
                        "type": "PRODUCTSKU",
                        "attributes": {
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "Sparkles",
                        "type": "DOUBLE",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "Bricks",
                        "type": "DOUBLE",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "Cement",
                        "type": "DOUBLE",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "Names",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "UNPUBLISHED",
                "testStatus": "NOT_VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "ae7d505b4e3288168a234c5e9f472b00",
                "eventName": "categoryViewed",
                "actions": [
                    "EIConsumer",
                    "EMFConsumer"
                ],
                "fields": [
                    {
                        "name": "customerId",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "MOBILE",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "categoryCode",
                        "type": "PRODUCTCATEGORY",
                        "attributes": {
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "Category Viewed",
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "3631d781a9ac9fee518bf6910d77a271",
                "eventName": "TestEvent1",
                "eventType": "PRODUCTEVENT",
                "actions": [
                    "EMFConsumer"
                ],
                "fields": [
                    {
                        "name": "customer",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "true",
                                "valueType": "Boolean"
                            },
                            "identifierType": {
                                "value": "mobile",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "till",
                        "type": "TILLCODE",
                        "attributes": {
                            "isRequired": {
                                "value": "true",
                                "valueType": "Boolean"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "sku",
                        "type": "PRODUCTSKU",
                        "attributes": {
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "Sparkles",
                        "type": "DOUBLE",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "Bricks",
                        "type": "DOUBLE",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "Cement",
                        "type": "DOUBLE",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "Names",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "UNPUBLISHED",
                "testStatus": "NOT_VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "date": 1747636361544,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "1390fd606e560de05dd45a6bd6555b7f",
                "eventName": "addedToCart",
                "eventType": "PRODUCTEVENT",
                "actions": [
                    "EIConsumer",
                    "EMFConsumer"
                ],
                "fields": [
                    {
                        "name": "customerId",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "MOBILE",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        },
                        "standardField": true
                    },
                    {
                        "name": "cartId",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        },
                        "standardField": true
                    },
                    {
                        "name": "skuCode",
                        "type": "PRODUCTSKU",
                        "attributes": {
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        },
                        "standardField": true
                    },
                    {
                        "name": "brandCode",
                        "type": "PRODUCTBRAND",
                        "attributes": {
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        },
                        "standardField": true
                    },
                    {
                        "name": "categoryCode",
                        "type": "PRODUCTCATEGORY",
                        "attributes": {
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        },
                        "standardField": true
                    },
                    {
                        "name": "quantity",
                        "type": "DOUBLE",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        },
                        "standardField": true
                    },
                    {
                        "name": "price",
                        "type": "DOUBLE",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        },
                        "standardField": true
                    },
                    {
                        "name": "productName",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        },
                        "standardField": true
                    },
                    {
                        "name": "productType",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        },
                        "standardField": true
                    }
                ],
                "orgId": 100737,
                "status": "UNPUBLISHED",
                "testStatus": "NOT_VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "Added To Cart",
                "description": "Added To Cart",
                "date": 1747636361544,
                "standardEvent": true
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "2fedcc95da465d06504b8fe9e36917b4",
                "eventName": "TestingEvent_FE",
                "eventType": "USEREVENT",
                "actions": [
                    "EMFConsumer",
                    "EIConsumer"
                ],
                "fields": [
                    {
                        "name": "Customer",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "mobile",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "TestingEvent_FE",
                "date": 1747636361545,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "45319f76a7d8d9a8c108ecc75bd85767",
                "eventName": "promotionViewed",
                "actions": [
                    "EIConsumer",
                    "EMFConsumer"
                ],
                "fields": [
                    {
                        "name": "customerId",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "MOBILE",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "promotionId",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    },
                    {
                        "name": "promotionName",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "Promotion Viewed",
                "date": 1747636361552,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": {
                    "eventNameMapping": {
                        "valueMap": {
                            "promotionViewed": "promotionViewed"
                        }
                    },
                    "eventFieldMappings": [
                        {
                            "eventFieldName": "customerId"
                        },
                        {
                            "eventFieldName": "promotionId"
                        },
                        {
                            "eventFieldName": "promotionName"
                        }
                    ]
                },
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "dbfca3b86bd501fa6fa92b0c682b8f58",
                "eventName": "Event_Rutuja",
                "actions": [
                    "EIConsumer"
                ],
                "fields": [
                    {
                        "name": "customer",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "false",
                                "valueType": "Boolean"
                            },
                            "identifierType": {
                                "value": "mobile",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "String",
                        "type": "TILLCODE",
                        "attributes": {
                            "isRequired": {
                                "value": "false",
                                "valueType": "Boolean"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "date": 1747636361552,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "f51e85918c4496c0fefad7859cffb430",
                "eventName": "testing_event",
                "eventType": "USEREVENT",
                "actions": [
                    "EIConsumer"
                ],
                "fields": [
                    {
                        "name": "userId",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "userId",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    },
                    {
                        "name": "deviceId",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    },
                    {
                        "name": "testing_event",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "UNPUBLISHED",
                "testStatus": "NOT_VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "testing_event",
                "description": "un/subscribe a Channel",
                "date": 1747636361552,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "92b06dd34906b983474a3414b72bb635",
                "eventName": "TestingEvent_FE_Rutuja",
                "eventType": "USEREVENT",
                "actions": [
                    "EMFConsumer",
                    "EIConsumer"
                ],
                "fields": [
                    {
                        "name": "CustomerId",
                        "type": "CUSTOMER",
                        "attributes": {
                            "accountId": {
                                "valueType": "ENUM"
                            },
                            "addCustomerIfNotExists": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "identifierType": {
                                "value": "mobile",
                                "valueType": "ENUM"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "source": {
                                "value": "INSTORE",
                                "valueType": "ENUM"
                            }
                        }
                    }
                ],
                "orgId": 100737,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "connectedOrgContext": {
                    "orgType": "STANDARD_ORG"
                },
                "label": "TestingEvent_FE",
                "date": 1747636361552,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        }
    ],
    "warnings": [],
    "errors": []
}
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!