# ui_extension_errored The `ui_extension_errored` event logs occurrences when an extension fails to render due to an uncaught exception in the extension code. This event is only available on checkout. ### Accessing Standard Events ```javascript import {register} from '@shopify/web-pixels-extension'; register(({analytics}) => { analytics.subscribe('ui_extension_errored', (event) => { // Example for accessing event data const {apiVersion, appId, appName, appVersion, trace} = event.data.alert; const payload = { event_name: event.name, event_data: { apiVersion, appId, appName, appVersion, trace, }, }; // Example for sending event data to third party servers fetch('https://example.com/pixel', { method: 'POST', body: JSON.stringify(payload), keepalive: true, }); }); }); ``` ```javascript analytics.subscribe('ui_extension_errored', (event) => { // Example for accessing event data const {apiVersion, appId, appName, appVersion, trace} = event.data.alert; const payload = { event_name: event.name, event_data: { apiVersion, appId, appName, appVersion, trace, }, }; // Example for sending event to third party servers fetch('https://example.com/pixel', { method: 'POST', body: JSON.stringify(payload), keepalive: true, }); }); ``` ## Properties ### PixelEventsUiExtensionErrored The `ui_extension_errored` event logs an instance of a UI extension encountering an error. ### clientId The client-side ID of the customer, provided by Shopify ### context ### data ### id The ID of the customer event ### name The name of the customer event ### seq The sequence index number of the event. ### timestamp The timestamp of when the customer event occurred, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format ### type ### Context A snapshot of various read-only properties of the browser at the time of event ### document Snapshot of a subset of properties of the `document` object in the top frame of the browser ### navigator Snapshot of a subset of properties of the `navigator` object in the top frame of the browser ### window Snapshot of a subset of properties of the `window` object in the top frame of the browser ### WebPixelsDocument A snapshot of a subset of properties of the `document` object in the top frame of the browser ### characterSet Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the character set being used by the document ### location Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the URI of the current document ### referrer Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the URI of the page that linked to this page ### title Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document), returns the title of the current document ### Location A snapshot of a subset of properties of the `location` object in the top frame of the browser ### hash Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing a `'#'` followed by the fragment identifier of the URL ### host Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the host, that is the hostname, a `':'`, and the port of the URL ### hostname Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the domain of the URL ### href Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the entire URL ### origin Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the canonical form of the origin of the specific location ### pathname Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing an initial `'/'` followed by the path of the URL, not including the query string or fragment ### port Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the port number of the URL ### protocol Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing the protocol scheme of the URL, including the final `':'` ### search Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Location), a string containing a `'?'` followed by the parameters or "querystring" of the URL ### WebPixelsNavigator A snapshot of a subset of properties of the `navigator` object in the top frame of the browser ### cookieEnabled Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns `false` if setting a cookie will be ignored and true otherwise ### language Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns a string representing the preferred language of the user, usually the language of the browser UI. The `null` value is returned when this is unknown ### languages Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns an array of strings representing the languages known to the user, by order of preference ### userAgent Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Navigator), returns the user agent string for the current browser ### WebPixelsWindow A snapshot of a subset of properties of the `window` object in the top frame of the browser ### innerHeight Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the height of the content area of the browser window including, if rendered, the horizontal scrollbar ### innerWidth Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the width of the content area of the browser window including, if rendered, the vertical scrollbar ### location Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the location, or current URL, of the window object ### origin Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the global object's origin, serialized as a string ### outerHeight Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the height of the outside of the browser window ### outerWidth Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), gets the width of the outside of the browser window ### pageXOffset Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), an alias for window.scrollX ### pageYOffset Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), an alias for window.scrollY ### screen Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen), the interface representing a screen, usually the one on which the current window is being rendered ### screenX Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the horizontal distance from the left border of the user's browser viewport to the left side of the screen ### screenY Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the vertical distance from the top border of the user's browser viewport to the top side of the screen ### scrollX Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the number of pixels that the document has already been scrolled horizontally ### scrollY Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window), the number of pixels that the document has already been scrolled vertically ### Screen The interface representing a screen, usually the one on which the current window is being rendered ### height Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen/height), the height of the screen ### width Per [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Screen/width), the width of the screen ### PixelEventsUiExtensionErroredData ### error ### UiExtensionError An object that contains data about a UI Extension error that occurred. ### apiVersion The API version used by the extension. ### appId The unique identifier of the app that the extension belongs to. ### appName The name of the app that the extension belongs to. ### appVersion The version of the app that encountered the error. ### extensionName The name of the extension that encountered the error. ### extensionTarget The [target](https://shopify.dev/docs/api/checkout-ui-extensions/latest/targets) of the extension, for example "purchase.checkout.delivery-address.render-after". ### message The message associated with the error that occurred. ### placementReference The [placement reference](https://shopify.dev/docs/apps/build/checkout/test-checkout-ui-extensions#dynamic-targets) of the extension, only populated for dynamic targets. ### trace The stack trace associated with the error that occurred. ### type The type of error that occurred. ### UiExtensionErrorType ### ExtensionUsageError ### EventType ### AdvancedDom ### Custom ### Dom ### Standard