Activate Storefront Pixel

POST

api

integrations

{id}

pixel

Activate Storefront Pixel

curl --request POST \
  --url https://api.sequenzy.com/api/v1/integrations/{id}/pixel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/integrations/{id}/pixel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/integrations/{id}/pixel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/integrations/{id}/pixel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/integrations/{id}/pixel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "integrationId": "int_abc123",
  "provider": "shopify",
  "shopDomain": "example.myshopify.com",
  "pixel": {
    "installed": true,
    "id": "gid://shopify/WebPixel/4124934472",
    "endpoint": "https://api.sequenzy.com/api/webhooks/commerce/shopify/comp_123/customer-events",
    "endpointCurrent": true,
    "configurationCurrent": true,
    "healthy": true,
    "error": null
  },
  "changed": true,
  "created": true,
  "dependentEvents": [
    "ecommerce.product_viewed",
    "ecommerce.collection_viewed",
    "ecommerce.search_submitted",
    "ecommerce.product_added_to_cart",
    "ecommerce.cart_started",
    "ecommerce.cart_cleared",
    "ecommerce.browse_abandoned",
    "ecommerce.cart_abandoned"
  ],
  "message": "Storefront pixel installed. On-site events start arriving on the next storefront visit; nothing is backfilled for visits that happened while it was off."
}

{
  "success": false,
  "error": "Shopify refused to install the pixel because the app is missing the required storefront tracking permissions (ACCESS_DENIED: Access denied for webPixelCreate). Reinstall or reconnect Shopify from Settings -> Integrations in the dashboard to grant them, then retry."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: integrations:manage"
}

{
  "success": false,
  "error": "Integration not found"
}

Install the storefront tracking pixel on a connected Shopify store, or repoint an existing pixel at this account. This is the step that turns on product views, cart activity, and browse abandonment - the data every browse-abandonment and cart-recovery sequence depends on. Run it before building those sequences: events start flowing on the next storefront visit, and nothing is backfilled for the period the pixel was off. Idempotent. A pixel that is already installed and current returns changed: false without writing to the store. Shopify only. Other providers return a 400. Requires an API key with the integrations:manage scope.

Request

string

required

Shopify integration ID, from List Integrations.

This endpoint takes no request body.

curl -X POST "https://api.sequenzy.com/api/v1/integrations/int_abc123/pixel" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response fields

boolean

false when the pixel was already installed and reporting to this account.

boolean

true when a new pixel was installed on the store.

boolean

true when an existing pixel was repointed at this account.

object

Pixel state after activation. Same shape as Get Storefront Pixel.

array

Event names this pixel enables.

Permissions

If the store granted the app an older permission set, Shopify refuses the install and this endpoint returns a 400 naming the reconnect step. Reconnect Shopify from Settings -> Integrations in the dashboard to grant storefront tracking permissions, then retry.

Responses

{
  "success": true,
  "integrationId": "int_abc123",
  "provider": "shopify",
  "shopDomain": "example.myshopify.com",
  "pixel": {
    "installed": true,
    "id": "gid://shopify/WebPixel/4124934472",
    "endpoint": "https://api.sequenzy.com/api/webhooks/commerce/shopify/comp_123/customer-events",
    "endpointCurrent": true,
    "configurationCurrent": true,
    "healthy": true,
    "error": null
  },
  "changed": true,
  "created": true,
  "dependentEvents": [
    "ecommerce.product_viewed",
    "ecommerce.collection_viewed",
    "ecommerce.search_submitted",
    "ecommerce.product_added_to_cart",
    "ecommerce.cart_started",
    "ecommerce.cart_cleared",
    "ecommerce.browse_abandoned",
    "ecommerce.cart_abandoned"
  ],
  "message": "Storefront pixel installed. On-site events start arriving on the next storefront visit; nothing is backfilled for visits that happened while it was off."
}

{
  "success": false,
  "error": "Shopify refused to install the pixel because the app is missing the required storefront tracking permissions (ACCESS_DENIED: Access denied for webPixelCreate). Reinstall or reconnect Shopify from Settings -> Integrations in the dashboard to grant them, then retry."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: integrations:manage"
}

{
  "success": false,
  "error": "Integration not found"
}

Activate Storefront Pixel

curl --request POST \
  --url https://api.sequenzy.com/api/v1/integrations/{id}/pixel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/integrations/{id}/pixel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/integrations/{id}/pixel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/integrations/{id}/pixel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/integrations/{id}/pixel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "integrationId": "int_abc123",
  "provider": "shopify",
  "shopDomain": "example.myshopify.com",
  "pixel": {
    "installed": true,
    "id": "gid://shopify/WebPixel/4124934472",
    "endpoint": "https://api.sequenzy.com/api/webhooks/commerce/shopify/comp_123/customer-events",
    "endpointCurrent": true,
    "configurationCurrent": true,
    "healthy": true,
    "error": null
  },
  "changed": true,
  "created": true,
  "dependentEvents": [
    "ecommerce.product_viewed",
    "ecommerce.collection_viewed",
    "ecommerce.search_submitted",
    "ecommerce.product_added_to_cart",
    "ecommerce.cart_started",
    "ecommerce.cart_cleared",
    "ecommerce.browse_abandoned",
    "ecommerce.cart_abandoned"
  ],
  "message": "Storefront pixel installed. On-site events start arriving on the next storefront visit; nothing is backfilled for visits that happened while it was off."
}

{
  "success": false,
  "error": "Shopify refused to install the pixel because the app is missing the required storefront tracking permissions (ACCESS_DENIED: Access denied for webPixelCreate). Reinstall or reconnect Shopify from Settings -> Integrations in the dashboard to grant them, then retry."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: integrations:manage"
}

{
  "success": false,
  "error": "Integration not found"
}

Overview

Companies

Sync Rules

Shopify

Websites

Integrations

Sender Profiles

Tracking Settings

Notification Preferences

Subscribers

Tags

Lists

Events

Segments

Audience Syncs

Migrations

Products

Media

Analytics

Sequences

Generation

SMS

Campaigns

Landing Pages

Emails

A/B Tests

Email Sends

Suppressions

Transactional

Templates

Widgets

Commerce

Webhooks

Team

Conversations

Activate Storefront Pixel

Request

Response fields

Permissions

Responses

​Request

​Response fields

​Permissions

​Responses

Request

Response fields

Permissions

Responses