custom-actions.adoc

Custom actions

ThoughtSpot provides a set of standard menu commands and buttons, controlled via actions.

Custom actions add a new menu item to one of the following UI elements:

• the primary menu bar

• the More menu

• the contextual menu that appears when a user right-clicks on an Answer or visualization
  

  Note	The VizPointClick HostEvent behaves in the same way as a context menu custom action, but fires immediately on a click rather than from the right-click context menu.

Custom actions are implemented in two parts:

• Within ThoughtSpot, define the new menu item and its placement

• In the embedding app, build code to receive the event and data when the user clicks the menu action.

Define custom actions in ThoughtSpot

You must create custom actions in the Develop > Customizations > Custom actions page of the ThoughtSpot UI.

After a custom action has been created, there are several options for assigning how and where the custom action will appear:

• Assign custom actions to an answer or a visualization on a Liveboard

• Assign custom actions to a worksheet

• Set the menu position of a custom action

Ways for embedding apps to receive custom actions

• Callback actions
  Pass data and metadata from ThoughtSpot to the embedding page as an event.

• URL actions
  POST data directly to a specific web page or API endpoint destination.