CTA — Poll Sticker

The LiSA Player generates a message whenever a CTA on a Poll Sticker Card in the Live Player is clicked.

This message is sent by the LiSA Player to the host app / environment.

Properties

Along with all standard CTA message properties, a Poll Sticker message includes the following additional properties:

Name
Type
Description

auxiliaryData

Required.

The auxiliaryData property is an object that holds additional metadata related to a Call-to-Action. Please refer to AuxiliaryData for detailed information.

ctaType

Required.

poll


Type Definition

interface PollStickerCtaMessage extends Omit<
  CtaMessage,
  'auxiliaryData' | 'ctaType'
> {
  auxiliaryData: PollStickerCtaAuxiliaryData;
  ctaType: 'poll';
}

AuxiliaryData

Name
Type
Description

pollId

Required.

The pollId field represents a unique identifier for the Poll Sticker.

pollState

Required.

The sponsorLabel field represents the text displayed on the sponsor badge in the Player header.

ctaActionTarget

Optional.

The ctaActionTarget property represents the (localized) action to be executed when a user interacts with the Poll Sticker CTA element. It can be an identifier, a structured JSON payload, or a URL that opens in a new tab. Refer to CtaActionTarget for detailed information.

Examples

CtaActionTarget

The Cta Action supports three different use cases:

  • Identifier (String) — Represents an action or event that the host app / environment can interpret and execute.

  • Structured Data (Object) — For more complex action definitions the action target contains an object structure.

Last updated