Skip to main content
Widget endpoints allow you to display interactive marketing content on customer-facing screens. Widgets are pre-configured marketing actions that customers can engage with during checkout, such as joining loyalty programs, viewing offers, or signing up for promotions.

​
What are Widgets?

Widgets are interactive marketing modules that appear on customer-facing screens (CFS). Using these endpoints, you can:
  • List Available Widgets: Get all active marketing widgets configured for a location
  • Start Widget Sessions: Launch a widget for customer interaction
  • Show QR Codes: Display QR codes for customers to scan and engage on mobile
  • Send Messages: Deliver marketing content via SMS or email

​
How It Works

Retrieve Widget List

Call the list widgets endpoint to get available marketing actions for your location.

Display Widget Options

Show widget choices on your customer-facing screen (e.g., “Join Loyalty Program”, “View Special Offers”).

Start Widget Session

When customer selects a widget, use start widget endpoint to initiate the interaction.

Show QR Code or Send Message

Display a QR code for mobile engagement or send content directly via SMS/email using the respective endpoints.

​
Widget Endpoints

Get Widgets List

Retrieve all available marketing widgets for a location

Start POS Widget Session

Launch a widget session for customer interaction

Show QR Code

Display QR code for customers to scan and engage

Send Message

Deliver widget content via SMS or email

​
Best Practices

Refresh Widget List Periodically

Fetch the widget list every 15-30 minutes or when your POS starts to ensure you display current marketing campaigns.
Show widgets appropriate for the current context (checkout, idle screen, post-purchase) based on widget configuration.
Let customers choose how to engage - QR code for mobile or direct SMS/email delivery. Support both methods.
Monitor which widgets customers interact with most to optimize your marketing strategy.
If a customer doesn’t interact with a widget within 30-60 seconds, timeout the session and return to idle state.

​
Common Widget Types

Widgets can be configured for various marketing actions:
  • Loyalty Enrollment: Sign up new customers for your loyalty program
  • Promotion Signup: Register for special offers or campaigns
  • Email/SMS Collection: Capture customer contact information
  • Coupon Delivery: Send discount codes to customers
  • Survey/Feedback: Collect customer feedback or preferences
  • Contest Entry: Enable customers to enter sweepstakes or giveaways
The widget list endpoint returns configured widgets with their specific actions and display settings.

​
Next Steps

Widget List API Reference

View complete API specification

Manual Flow Guide

Learn how to implement widget flows

Automated Flow Guide

Trigger widgets automatically based on events

QR Code Generation

Learn about QR code display options