Form Tracking¶

The form tracking plugin enables events that track form changes and submits on the site. This service is self-serving -- there are no available methods, and doesn't have any additional functionality to provide to other plugins.

This plugin additionally fires events required for the backend to provide information about form coverage and usage by the user.

Warning

This plugin only tracks standard web form elements. If you are using solutions like Bootstrap that don't follow the standard web form implementation, then you'll have to provide custom tracking.

We are currently in the process of providing configuration and adapters to track other form implementations. Check back later for updates on these developments!

Installation¶

This plugin requires no additional installation to be used correctly.

Configuration¶

This plugin requires no additional configuration.

Methods¶

This plugin has no public methods.

Events¶

Generated¶

This plugin generates the following events:

Action

Spec

Trigger

change

{
    object: "input",
    vendor: "Orbee",
    product: "Site Tracker",
    label: " <label for input>",
    input: {
        label: "<label for input>",
        value: // input value,
        valid: // whether input is valid
    }
}

Form input changed

submit

{
    object: "form",
    vendor: "Orbee",
    product: "Site Tracker",
    label: "<form name>",
    form: {
        form: {
            // fields as k: v
        },
        submit: {
            text: "",
            path: "<css query>",
            node: "",
            type: "button"
        },
        name: "<form name>",
        valid: // if form is valid
    }
}

Form is submitted

Listening¶

This plugin does not listen for any events.

Dependencies¶

This plugin does not depend on any other services or plugins.

Last update: 2023-04-13