Skip to main content

Widget Synchronization

Widget synchronization is the process of pulling your widget configurations from Particular Audience's platform into your Shopify store as metaobjects. This guide explains how to run and monitor widget sync.

Overview​

Widget synchronization:

  • Fetches widget data from Particular Audience's Widgets API
  • Maps widgets by type (recommendation, merchandising, bundle)
  • Writes widget configurations into the corresponding Shopify metaobject definitions
  • Tracks sync outcome and stores sync history for status and troubleshooting

Performing a Widget Sync​

Accessing Sync​

  1. Navigate to the app home page
  2. Use the control that triggers Configurations > Widget Sync > Sync Widgets now

Sync Process​

When you start a widget sync:

  1. Fetch: Widgets are retrieved from Particular Audience for your store
  2. Map by type: Widgets are grouped by type (recommendation, merchandising, bundle)
  3. Metaobject check: The app verifies that the required metaobject types exist in your store
  4. Write: Each widget type’s configurations are saved into the matching Shopify metaobject
  5. Completion: Sync result is recorded (success, partial, or failed) and history is updated

Monitoring Sync Progress​

After or during synchronization, the app can show:

  • Status: Success, Partial, or Failed
  • Synced count: Number of widget configurations written successfully
  • Failed count: Number that could not be written
  • Sync errors: Details for any failures (when available)

Sync Duration​

Sync duration depends on:

  • Widget count: Number of widgets and configurations to process
  • Metaobject types: How many widget types (and thus metaobject types) are involved
  • API response times: Particular Audience and Shopify API latency
  • Network conditions: Connection speed and stability
Background sync

Widget sync is typically quick. If the process is triggered from the app, you can continue using the app while it completes; status is available via sync status.

Sync History​

Sync History Information​

Each sync entry can show:

FieldDescription
StatusSuccess, Partial, or Failed
Total widgetsNumber of widgets processed
Synced countNumber written successfully
Failed countNumber that failed to sync
Start timeWhen the sync began
End timeWhen the sync completed

When to Perform Manual Sync​

  1. After widget changes in Particular Audience:

    • New widgets created
    • Widget names or types updated
    • Widgets removed or reassigned

  2. After metaobject setup:

    • New metaobject definitions added for widget types
    • Metaobject definitions updated to match expected widget types

  3. Initial setup:

    • First-time configuration of widgets in the app
    • After reconnecting or re-authenticating with Particular Audience

  4. After errors:

    • A previous sync reported Partial or Failed and you’ve fixed the cause (e.g. metaobject definitions or API access)