This web application event is intended for integration developers and can be used to store events occurring on Page designer components. This event can be retrieved using the Retrieve event web service.
It is possible to trigger a custom_event.trigger event through:
- the Trigger interface analytics events web service.
- the Trigger custom Analytics event JavaScript method in Custom components.
This event contains the following fields:
| Field | Description |
|---|---|
eventName |
Information about the custom name of the event. The string format accepts alphanumeric characters and the following special characters: _, -, and /. The maximum length of eventName is 100 characters. |
componentId |
This optional field contains information about the component which triggered the event. The string format accepts alphanumeric characters and the following special character: -. The maximum length of componentId is 100 characters. |
page |
An object containing information about the displayed page. |
id |
The page's identifier. |
type |
The page's type. The type can be designedHomePage, designedPage, designedReaderPage, designedSearchPage, homePage, readerPage, searchPage, viewerPage. |
url |
The URL path used to access the page. |
name |
The page's name. |
language |
The language defined for the page if it is a designed page. |
Example:
[
{
"eventName": "MyCustomEventName",
"componentId": "button-contact1",
"page": {
"id": "ft/home",
"type": "homePage",
"url": "/",
"name": "home",
"language": "en-US"
}
}
]