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": "886cf408af56fd3d56039785ab69c0c0",
                "eventName": "Appointment",
                "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": "Appointment",
                        "type": "STRING",
                        "attributes": {
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    },
                    {
                        "name": "Execname",
                        "type": "STRING",
                        "attributes": {
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100458,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "label": "Appointment",
                "description": "Appointment Booking",
                "date": 1718950314953,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "0b9c729eb499d60e95af7c56a00bdb5f",
                "eventName": "Imporvesleep",
                "eventType": "USEREVENT",
                "actions": [
                    "EMFConsumer",
                    "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": "sleephours",
                        "type": "DOUBLE",
                        "attributes": {
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            }
                        }
                    },
                    {
                        "name": "Alcoholbeforebed",
                        "type": "STRING",
                        "attributes": {
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100458,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "label": "Imporvesleep",
                "date": 1718950314953,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "26db0f5d191c6e1e66a5ee1f46c87d47",
                "eventName": "Productreview",
                "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": "Review",
                        "type": "STRING",
                        "attributes": {
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100458,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "label": "Productreview",
                "description": "Productreview",
                "date": 1718950314953,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": {
                    "eventNameMapping": {
                        "valueMap": {
                            "review": "Productreview"
                        }
                    },
                    "eventFieldMappings": [
                        {
                            "eventFieldName": "CustomerID",
                            "fieldName": "019742315078"
                        },
                        {
                            "eventFieldName": "Review",
                            "fieldName": "nice"
                        }
                    ]
                },
                "webEngageTransformerMapping": {
                    "eventNameMapping": {
                        "valueMap": {}
                    },
                    "eventFieldMappings": [
                        {
                            "eventFieldName": "CustomerID",
                            "fieldName": "customer"
                        },
                        {
                            "eventFieldName": "Review",
                            "fieldName": "review"
                        }
                    ]
                }
            }
        },
        {
            "clickEventsMeta": {
                "eventId": "9cb2c0f4ceb832ada037843b8c496760",
                "eventName": "Partner Linking",
                "eventType": "USEREVENT",
                "actions": [
                    "EMFConsumer",
                    "EIConsumer"
                ],
                "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": "Status",
                        "type": "STRING",
                        "attributes": {
                            "isPsiData": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "isRequired": {
                                "value": "true",
                                "valueType": "BOOLEAN"
                            },
                            "isUniqueKeyField": {
                                "value": "false",
                                "valueType": "BOOLEAN"
                            },
                            "regex": {
                                "valueType": "STRING"
                            }
                        }
                    }
                ],
                "orgId": 100458,
                "status": "PUBLISHED",
                "testStatus": "VERIFIED",
                "label": "Partner Linking",
                "description": "Partner Linking",
                "date": 1718950314953,
                "standardEvent": false
            },
            "transformerMappings": {
                "defaultTransformerMapping": null,
                "webEngageTransformerMapping": null
            }
        }
		],
		"warnings": [],
    "errors": []
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!