Web
Requires access scope.
The 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.
Anchor to FieldsFields
- •ID!non-null
A globally-unique ID.
- Anchor to settingssettings•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
.
Anchor to MutationsMutations
- •mutation
Activate a web pixel extension by creating a web pixel record on the store where you installed your app.
When you run the
mutation, Shopify validates it against the settings definition inshopify.extension.toml. If thesettingsinput field doesn't match the schema that you defined, then the mutation fails. Learn how to define web pixel settings.- Anchor to webPixelweb•Web
Pixel Pixel Input!required The web pixel settings in JSON format.
Arguments
- Anchor to userErrorsuser•[Errors
Errors Web Pixel User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to webPixelweb•Web
Pixel Pixel The created web pixel settings.
Fields
- •mutation
Activate a web pixel extension by updating a web pixel record on the store where you installed your app.
When you run the
mutation, Shopify validates it against the settings definition inshopify.extension.toml. If thesettingsinput field doesn't match the schema that you defined, then the mutation fails. Learn how to define web pixel settings.- •ID!required
The ID of the web pixel to update.
- Anchor to webPixelweb•Web
Pixel Pixel Input!required The web pixel settings in JSON format.
Arguments
- Anchor to userErrorsuser•[Errors
Errors Web Pixel User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to webPixelweb•Web
Pixel Pixel The updated web pixel settings.
Fields