v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB

Integrations

Activate storefront pixel

Installs the Shopify storefront tracking pixel, or repoints an existing one at this account. Idempotent - an already-live pixel returns changed false without writing to the store. Events start arriving on the next storefront visit; nothing is backfilled. Fails with a 400 naming the reconnect step when the store granted an older permission set. Shopify only. Requires the integrations:manage scope.

post/integrations/{id}/pixel

Path parameters

idstring required

Shopify integration ID.

Response

Pixel installed, repointed, or already live

successboolean

integrationIdstring

providerstring

shopDomainstring

dependentEventsstring[]

Event names that depend on this pixel. They are confirmed unable to arrive only when pixel.error is null and pixel.healthy is false.

messagestring

changedboolean

False when the pixel was already installed and current.

createdboolean

True when a new pixel was installed.

updatedboolean

True when an existing pixel was repointed.

Example response

{
  "success": true,
  "provider": "shopify",
  "shopDomain": "example.myshopify.com"
}