Candu’s SDK emits events to both Candu servers and your customer application. These events help track user interactions and analyze product usage. To familiarize yourself with all the identifiers, read more about Candu’s Entities. All Candu SDK events start with the prefix candu.sdk.

​

Common Events

Content events are generic events common to every type of content. Every SDK event includes a core set of identifiers. Depending on the event type, additional properties may be included.

​

candu.sdk.content

Fired when content renders on the page: after the user matches the Segment and display rules, the content mounts and its styles load. There is no viewport visibility check, so content rendered below the fold or inside a hidden element still fires this event. For Tours, this event can fire when the Tour loads even if a step’s target element is not on the page yet. To count Tour Steps that were actually shown, use candu.sdk.tour_step_tooltip.

​

Component Events

These are useful for tracking interactions. Component events always have a nodeId associated with them. Note that components do not have identifiers as they’re a logical grouping of Nodes. Component events have the following identifiers:

​

candu.sdk.content.interaction

A generic interaction event. This event is emitted by components like Button, Link, Card and any other component where an interaction can be specified.

​

candu.sdk.dismiss

A generic dismiss events. This action is emitted by Modal or Card when they are dismissed.

​

Checklists

​

candu.sdk.tutorial.checklist_group_complete

Event emitted once when all items in a Checklist have been completed. Includes the following additional properties: Includes the checklist title in the payload.

​

candu.sdk.tutorial.checklist_item_state_updated

Emitted when an individual checklist item’s state changes. Please note that event-driven Checklists do not emit this event. Includes the following additional properties: Includes the checklist title in the payload,

​

Flows

​

candu.sdk.flow_step

A Flow Step has been seen. This actions are emitted byFlowStepnodes when they are being displayed as part of a Flow.

​

Form

​

candu.sdk.form_submit

A Form has been submitted. The formId will be included in the body, as well as an encoded payload of all the Form fields.

​

Tour

​

candu.sdk.tour_step_tooltip

A Tour Step has been viewed.

​

candu.sdk.tour_step_dismissed

A step has been dismissed.

​

candu.sdk.tour_completed

The Tour has been completed.

​

Hotspot

​

candu.sdk.hotspot_tooltip

A Tooltip has been opened.

​

candu.sdk.hotspot_beacon

A Tooltip beacon has been rendered.

​

candu.sdk.hotspot_dismissed

A Hotspot has been permanently dismissed.

​

candu.sdk.hotspot_group_dismissed

All the Hotspots in a group have been dismissed.

​

Experimentation events

​

candu.sdk.impression

Tracks experiment variant views, including control group impressions. A User has seen an Experiment Variant. This happens when there is a matching Placement. In the case of control group, an impression occurs anytime a Placement matches for another Variant. The event has the following payload: