Widget Events

You can track widget activity using event listeners. For example, detect if the payment is ready to be submitted:

const scopes = ["*"];
manager.subscribe((event) => {
  if (event.code === "CHECKOUT_PAYMENT_FULFILLED_CHANGES") {
    const button = document.getElementById("my_custom_pay_button");
    event.payload.isFulfilled
      ? button.removeAttribute("disabled")
      : button.setAttribute("disabled", true);
  }
}, scopes);

Attach Listeners on Initialization

const widgetManager = widgetManager.buildForWidgetData(data, [
  { listener: myListenerFunction, scopes: ["*"] }
])

List of the widget scopes

Scope Name	Description
checkout_session	Events related to checkout session lifecycle
checkout_payment	Events for payment processing status
checkout_validation	Events during checkout validation process
checkout_validation_end	Final validation status events
wallet_session	Events related to wallet session management
wallet_actions	Events for wallet operations
widget_manager	Events from widget manager operations
widget_instance	Events related to widget lifecycle
widget_ui	Events from UI interactions
widget_navigation	Events for widget navigation state
widget_navigation_selection	Events for selection state changes
errors	Error events from various components

List of Event codes

Name	Description	Scopes
CHECKOUT_SESSION_SET	Triggered when a checkout session is set.	checkout_session
CHECKOUT_SESSION_EXPIRATION_BACKED_BY_SERVER_TIME	Checkout session expiration is synchronized with server time.
CHECKOUT_SESSION_EXPIRED	Indicates that the checkout session has expired.	checkout_session, errors
CHECKOUT_VALIDATION_START	Begins the validation process for the checkout.	checkout_validation
CHECKOUT_API_INIT_SUCCEEDED	API initialization for checkout was successful.
CHECKOUT_API_INIT_FAILED	API initialization for checkout failed.	errors
CHECKOUT_API_VALIDATION_SUCCEEDED	API validation for checkout was successful.
CHECKOUT_POST_VALIDATION_SUCCEEDED	Post-validation for the checkout succeeded.
CHECKOUT_POST_VALIDATION_FAILED	Post-validation for the checkout failed.	errors
CHECKOUT_VALIDATION_SUCCEEDED	The overall validation for the checkout succeeded.	checkout_validation, checkout_validation_end
CHECKOUT_VALIDATION_FAILED	The overall validation for the checkout failed.	checkout_validation_end, errors
CHECKOUT_PRE_VALIDATION_FAILED	Pre-validation for the checkout failed.	errors
CHECKOUT_PRE_VALIDATION_ALREADY_ROLLING	Pre-validation is already in progress.
CHECKOUT_PRE_VALIDATION_STARTING	Pre-validation for checkout is starting.
CHECKOUT_PAYMENT_FULFILLED_CHANGES	Indicates changes after the payment has been fulfilled.	checkout_payment
CHECKOUT_PAYMENT_FULLFILLED_ERROR	Indicates that an error occurred after the payment was fulfilled during the checkout process	checkout_payment, errors
WALLET_SESSION_SET	Triggered when a wallet session is set.	wallet_session
WALLET_SESSION_EXPIRED	Indicates that the wallet session has expired.	errors
WALLET_SESSION_EXPIRATION_BACKED_BY_SERVER_TIME	Wallet session expiration is synchronized with server time.
WALLET_TOKEN_DELETION_COMPLETE	A wallet token has been successfully deleted.	wallet_actions
WALLET_TOKEN_EDITION_COMPLETE	A wallet token has been successfully edited.
WALLET_ALL_TOKENS_DELETION_COMPLETE	All wallet tokens have been successfully deleted.	wallet_actions
WALLET_TOKEN_SET_AS_FAVORITE	A wallet token has been marked as favorite.
WIDGET_MANAGER_CREATE	A widget manager has been created.	widget_manager
WIDGET_MANAGER_ANALYTICS	Analytics event from widget manager.
WIDGET_MANAGER_SUBMIT_PAYMENT	A widget manager is submitting a payment.
WIDGET_SUBMIT_PAYMENT	A widget is submitting a payment.
WIDGET_GET_PLUGIN_FAILED	Failed to retrieve the widget plugin.
WIDGET_PROTOCOL_UNSTABLE_FILTER	Protocol instability detected for widget filtering.
WIDGET_PROTOCOL_PLUGIN_NOT_IMPLEMENTED	The required widget protocol plugin is not implemented.
WIDGET_CREATE	A widget has been created.	widget_instance
WIDGET_MOUNTED	A widget has been mounted.
WIDGET_UNMOUNTED	A widget has been unmounted.
WIDGET_FETCH_CONFIG_FAILED_SOFTLY	Soft failure while fetching widget configuration.
WIDGET_CONFIG_NAME_IS_MANDATORY_SHOULD_BE_UNIQUE	Widget configuration name is mandatory and must be unique.
WIDGET_CONFIG_SET	A widget configuration has been set.	widget_instance
WIDGET_MERGE_NAVIGATION_SELECTION_UPDATE	Navigation selection update during widget merge.	widget_navigation
WIDGET_MERGE_NAVIGATION_SELECTION_SKIPPED	Navigation selection was skipped during widget merge.	widget_navigation, widget_navigation_selection
WIDGET_MERGE_NAVIGATION_FOCUS_UPDATE	Navigation focus update during widget merge.	widget_navigation
WIDGET_MERGE_NAVIGATION_TRY_TO_SELECT_SUSPENDED_ITEM	Attempted to select a suspended item during navigation merge.
WIDGET_MERGE_NAVIGATION_SELECTED_ITEM_IS_NOW_SUSPENDED	A selected item is now suspended during navigation merge.
WIDGET_MERGE_NAVIGATION_OPEN_UPDATE	Navigation open state update during widget merge.	widget_navigation
WIDGET_NAVIGATION_PRIMARY_UPDATE	Update to primary navigation.	widget_navigation, widget_navigation_selection
WIDGET_NAVIGATION_SECONDARY_UPDATE	Update to secondary navigation.	widget_navigation, widget_navigation_selection
WIDGET_SUBMISSION_AFTER_PARTNER_SDK_REJECTION	Submission attempt after partner SDK rejection.
WIDGET_UI_SAVE_TOKEN_OPTIN_CHANGED	User changed the save token opt-in.
WIDGET_UI_BUTTON_CLICK	User clicked a widget button.
WIDGET_UI_TOKEN_SELECTED	User selected a token in the UI.	widget_ui
WIDGET_UI_TOKEN_UNSELECTED	User unselected a token in the UI.	widget_ui
WIDGET_UI_METHOD_SELECTED	A payment method has been selected.	widget_ui
WIDGET_UI_METHOD_UNSELECTED	A payment method has been unselected.	widget_ui
WIDGET_FIELD_VALIDATED	A field has been validated.
WIDGET_FIELD_BLUR	A field has lost focus.
REDIRECTION	A redirection event occurred.
UNCAUGHT_ERROR	An uncaught error occurred.	errors
PAGE_UNLOAD	Triggered when the page is being unloaded.