Listen for Widget State Changes with Custom Events

Listen for customer selections and trigger custom actions when delivery or pickup options change.

Custom events let you respond to customer interactions with your Bird Pickup & Delivery widget. Use them to update other page elements, track user behavior, or integrate with third-party services.

What Are Custom Events?

Custom events fire automatically when customers:

Change delivery methods
Select delivery or pickup dates
Choose time slots

These events fire in real-time as customers interact with the widget. This allows you to build custom responsive, dynamic experiences that update immediately when selections change.

How to Implement Custom Events

Step 1: Enable Custom Events

Custom events are not enabled by default. Contact our support team to activate this feature for your store.

Step 2: Listen for Events

Listen for birdchime:schedule event to track widget state changes. Below is an example JavaScript code that listens for widget state changes and logs them to the console:

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

Event Data Structure

Example of returned response with delivery method pickup, date and time selected:

{
    "Delivery Method": "Pick Up",
    "Customer TimeZone": "America/Los_Angeles",
    "timestamp": "2025-08-20 12:07:42",
    "Delivery Location": "3363 Rivers Avenue , North Charleston, SC, US",
    "locationId": 100543,
    "shopifyLocationId": 83733479672,
    "Delivery Date": "Aug 23, 2025",
    "Delivery Day": "Saturday"
}

Troubleshooting

Event Not Firing?

Verify activation: Confirm custom events are enabled for your store by checking with our Support
Check console: Look for JavaScript errors in browser developer tools
Widget loading: Ensure the Bird Pickup & Delivery widget loads before your event listeners

Updated on: 09/25/2025

Was this article helpful?

Thank you!