Legacy Widget (V1) and REST API

Only for stores still on the older (V1) widget. On the current widget, use the Widget API Reference. The old events map to the new ones: birdchime:initialized → bird:widget:initialized, birdchime:reinitialized → bird:widget:reinitialized, birdchime:schedule → bird:selection:changed.

JavaScript API (BirdSDK)

You can run the following in the developer console when the legacy widget is installed in your theme.

Get the current selection made by the customer in the widget

BirdSDK.session.getState('selections')

Whether to show widget or not

BirdSDK.helpers.shouldHideWidget()

Check postal code eligibility

BirdSDK.helpers.checkPostcodeEligibility('V6Z 3C1').then((data) => console.log(data))

Clear data recorded by Bird app for the cart

BirdSDK.helpers.clearCartSelections()

Get the checkout parameters

BirdSDK.helpers.getCheckoutParams()

Events (birdchime:*)

The V1 widget dispatches these on document.

birdchime:initialized

Fires once, when the widget first loads.

document.addEventListener('birdchime:initialized', function({ detail }) {
  console.log('BirdChime widget initialized:', detail);
});

birdchime:reinitialized

Fires whenever the widget is re-rendered (for example after an AJAX cart update).

document.addEventListener('birdchime:reinitialized', function({ detail }) {
  console.log('BirdChime widget reinitialized:', detail);
});

birdchime:schedule

Fires any time the customer changes a selection (method, date or time).

document.addEventListener('birdchime:schedule', function({ detail }) {
  console.log('Schedule event details:', detail);
});

Event data structure

Example data returned when the customer selects Local Delivery with a chosen date and time:

{
  "Delivery Method": "Delivery",
  "_BirdChimeSlotId": "M=D;L=105145;D=2025-11-26;T=9:00 AM - 6:00 PM;TS=2025-11-12 11:32:30;S=R;Z=",
  "locationId": 105145,
  "shopifyLocationId": 80424370330,
  "Delivery Date": "Nov 26, 2025",
  "Delivery Day": "Wednesday",
  "Delivery Time": "9:00 AM - 6:00 PM"
}

REST API

For server-side integrations only: https://picdel.birdchime.com/api-docs. On a storefront or in an app, use the Widget API Reference instead.