form_submitted
interface

The form_submitted event logs an instance where a form on a page is submitted.

Anchor to propertiesProperties

Anchor to clientId clientId string: The client-side ID of the customer, provided by Shopify
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 .Dom

PixelEventsFormSubmittedData

element
```
FormElement
```

export interface PixelEventsFormSubmittedData {
  element?: FormElement;
}

FormElement

An object that contains data about a form element type

action
The action attribute of a form element
```
string | null
```
elements
```
InputElement[]
```
id
The id attribute of an element
```
string | null
```

export interface FormElement {
  /**
   * The action attribute of a form element
   */
  action?: string | null;
  elements?: InputElement[];

  /**
   * The id attribute of an element
   */
  id?: string | null;
}

InputElement

An object that contains data about an input element type

id
The id attribute of an element
```
string | null
```
name
The name attribute of an element
```
string | null
```
tagName
A string representation of the tag of an element
```
string | null
```
type
The type attribute of an element. Often relevant for an input or button element.
```
string | null
```
value
The value attribute of an element. Often relevant for an input element.
```
string | null
```

export interface InputElement {
  /**
   * The id attribute of an element
   */
  id?: string | null;

  /**
   * The name attribute of an element
   */
  name?: string | null;

  /**
   * A string representation of the tag of an element
   */
  tagName?: string | null;

  /**
   * The type attribute of an element. Often relevant for an input or button
   * element.
   */
  type?: string | null;

  /**
   * The value attribute of an element. Often relevant for an input element.
   */
  value?: string | null;
}

EventType

AdvancedDom
```
advanced-dom
```
Custom
```
custom
```
Dom
```
dom
```
Meta
```
meta
```
Standard
```
standard
```

export enum EventType {
  AdvancedDom = 'advanced-dom',
  Custom = 'custom',
  Dom = 'dom',
  Meta = 'meta',
  Standard = 'standard',
}

Was this section helpful?

Accessing DOM Events

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

analytics.subscribe('form_submitted', (event) => {

// Example for accessing event data

const element = event.data.element;

const elementId = element.id;

const formAction = element.action;

const emailRegex = /email/i;

const [email] = element.elements

.filter((item) => emailRegex.test(item.id) || emailRegex.test(item.name))

.map((item) => item.value);

const formDetails = element.elements.map((item) => {

return {

id: item.id,

name: item.name,

value: item.value,

};

});

const payload = {

event_name: event.name,

event_data: {

id: elementId,

url: formAction,

email: email,

formDetails: formDetails,

};

// Example for sending event to third party servers

fetch('https://example.com/pixel', {

method: 'POST',

body: JSON.stringify(payload),

keepalive: true,

});

Examples

Accessing DOM Events

App Pixel

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

register(({analytics}) => {
  analytics.subscribe('form_submitted', (event) => {
    // Example for accessing event data
    const element = event.data.element;

    const elementId = element.id;
    const formAction = element.action;
    const emailRegex = /email/i;
    const [email] = element.elements
      .filter((item) => emailRegex.test(item.id) || emailRegex.test(item.name))
      .map((item) => item.value);
    const formDetails = element.elements.map((item) => {
      return {
        id: item.id,
        name: item.name,
        value: item.value,
      };
    });

    const payload = {
      event_name: event.name,
      event_data: {
        id: elementId,
        url: formAction,
        email: email,
        formDetails: formDetails,
      },
    };

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

Custom Pixel

analytics.subscribe('form_submitted', (event) => {
  // Example for accessing event data
  const element = event.data.element;

  const elementId = element.id;
  const formAction = element.action;
  const emailRegex = /email/i;
  const [email] = element.elements
    .filter((item) => emailRegex.test(item.id) || emailRegex.test(item.name))
    .map((item) => item.value);
  const formDetails = element.elements.map((item) => {
    return {
      id: item.id,
      name: item.name,
      value: item.value,
    };
  });

  const payload = {
    event_name: event.name,
    event_data: {
      id: elementId,
      url: formAction,
      email: email,
      formDetails: formDetails,
    },
  };

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

form_submittedinterface

Anchor to propertiesProperties

PixelEventsFormSubmittedData

FormElement

InputElement

EventType

Examples

Accessing DOM Events

App Pixel

Custom Pixel

form_submitted
interface