Web Pixel settings field in shopify.extension.toml

Shopify Apps

Topic summary

A developer is working through Shopify’s Build Web Pixels tutorial and has successfully created a web pixel extension and connected it to dev stores using the GraphQL example from Step 5.

The main question concerns the shopify.extension.toml configuration file:

  • What do the settings defined in this file actually do? The developer references a default sample from the documentation that includes fields like settings.fields.accountID with properties such as type, description, name, and validations.
  • What is the use case for settings.fields.accountID? The purpose of this specific field is unclear.
  • Is it safe to remove from the settings? The developer wants to know if this field is required or optional.

The discussion remains open with no responses yet, indicating the developer is seeking clarification on how web pixel extension settings work and which configuration fields are necessary versus optional.

Summarized with AI on November 4. AI used: claude-sonnet-4-5-20250929.
1

Hello, I am following Build web pixels tutorial. So far, I have managed to create a web pixel extension and connect it to my dev stores using GraphQL example in Step 5. However, I couldn’t find an explanation what do the settings defined in shopify.extension.toml actually do. Default sample provided in the docs is:

type = "web_pixel_extension"
name = "pixel"
runtime_context = "strict"

[customer_privacy]
analytics = true
marketing = true
preferences = false
sale_of_data = "enabled"

[settings]
type = "object"

[settings.fields.accountID]
name = "Account ID"
description = "Account ID"
type = "single_line_text_field"
validations = [
{ name = "min", value = "1" }
]

What is the use-case for settings.fields.accountID? Is it safe to remove it from the settings?