Skip to main content

alert_displayed
interface

The alert_displayed event records instances when a user encounters an alert message, whether it's an inline validation message on an input field or a warning banner.

Note

This event is only available on checkout.

Anchor to propertiesProperties

Anchor to clientId
clientId
string

The client-side ID of the customer, provided by Shopify

Anchor to context
context
Anchor to data
data
Anchor to id
id
string

The ID of the customer event

Anchor to name
name
string

The name of the customer event

Anchor to seq
seq
number

The sequence index number of the event.

Anchor to timestamp
timestamp
string

The timestamp of when the customer event occurred, in ISO 8601 format

Anchor to type
type
.Standard
Was this section helpful?

Accessing Standard Events

import {register} from '@shopify/web-pixels-extension';

register(({analytics}) => {
analytics.subscribe('alert_displayed', (event) => {
// Example for accessing event data
const {target, type, message} = event.data.alert;

const payload = {
event_name: event.name,
event_data: {
target,
type,
message,
},
};

// Example for sending event data to third party servers
fetch('https://example.com/pixel', {
method: 'POST',
body: JSON.stringify(payload),
keepalive: true,
});
});
});