Skip to main content
Log inSign up
object

Requires read_pixels access scope.

The WebPixel object enables you to manage JavaScript code snippets that run on an online store and collect behavioral data for marketing campaign optimization and analytics.

Learn how to create a web pixel extension to subscribe your app to events that are emitted by Shopify.

ID!non-null

A globally-unique ID.

JSON!non-null

The settings object for the web pixel. This object specifies configuration options that control the web pixel's functionality and behavior. You can find the settings for a web pixel in extensions/<your_extension_name>/shopify.extension.toml.


Was this section helpful?

query

Returns a web pixel by ID.


Was this section helpful?

mutation

Activate a web pixel extension by creating a web pixel record on the store where you installed your app.

When you run the webPixelCreate mutation, Shopify validates it against the settings definition in shopify.extension.toml. If the settings input field doesn't match the schema that you defined, then the mutation fails. Learn how to define web pixel settings.

mutation

Activate a web pixel extension by updating a web pixel record on the store where you installed your app.

When you run the webPixelUpdate mutation, Shopify validates it against the settings definition in shopify.extension.toml. If the settings input field doesn't match the schema that you defined, then the mutation fails. Learn how to define web pixel settings.


Was this section helpful?

interface

Was this section helpful?