custom_event.trigger - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

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 retrieve using the Retrieve event web service.

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 /.
componentId This optional field contains information about the component which triggerd the event. The string format accepts alphanumeric characters and the following special character: -.
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.