Tracking Integrations

Connect Meta CAPI, TikTok Events API, Google Ads, GA4, Snapchat, and custom webhooks to your domain.

Tracking integrations connect your domain to ad platforms so the gateway can forward conversion events server-side. Each integration stores the credentials needed to authenticate with the platform's API.

Adding an Integration

  1. Navigate to your domain in the dashboard
  2. Open the Tracking tab
  3. Click the Integrations sub-tab
  4. Click Add Integration
  5. Select a platform (Meta CAPI, TikTok Events API, Google Ads, Custom Webhook, Google Analytics 4, or Snapchat)
  6. Enter the required credentials
  7. Click Save

The integration starts in an Active state and will receive events from any rule with a fire_conversion_event action.

Platform Credentials

Meta Conversions API (CAPI)

FieldDescription
Access TokenA long-lived system user access token from Meta Business Manager. Required scopes: ads_management and business_management.
Pixel IDYour Meta Pixel ID — found in Events Manager under your pixel's settings.
Test Event CodeOptional. When set, events are sent to the Test Events tab in Events Manager instead of production. Remove before going live.

Generate a system user access token in Meta Business Manager > Business Settings > System Users. System user tokens do not expire, unlike user tokens.

TikTok Events API

FieldDescription
Access TokenGenerated in TikTok Events Manager under Settings > Generate Access Token.
Pixel CodeYour TikTok Pixel Code — found in Events Manager under your pixel's details.
FieldDescription
Customer IDYour Google Ads account Customer ID (format: 123-456-7890).
Conversion Action IDThe ID of the conversion action to attribute events to — found in Tools > Conversions in Google Ads.
Refresh TokenOAuth refresh token for authenticating API requests. Generated via the Google OAuth consent flow.
Client IDOAuth client ID from your Google Cloud project credentials.
Client SecretOAuth client secret from your Google Cloud project credentials.

Google Ads uses OAuth for authentication. Create OAuth credentials in the Google Cloud Console > APIs & Services > Credentials, then use the OAuth consent flow to generate a refresh token.

Custom Webhook

FieldDescription
Endpoint URLThe target URL for the HTTP request (e.g., https://your-api.com/conversions).
HTTP MethodPOST (default), PUT, or PATCH.
HeadersOptional key-value pairs sent with each request (e.g., Authorization: Bearer token).
Body TemplateJSON template with {{variable}} interpolation. Available variables include {{event_type}}, {{value}}, {{currency}}, {{order_id}}, and user data fields.

Webhooks are ideal for forwarding conversion events to internal analytics systems, data warehouses, or any HTTP-compatible endpoint. Use body templates to match the exact schema your endpoint expects.

Google Analytics 4 (Measurement Protocol)

FieldDescription
Measurement IDYour GA4 stream ID (format: G-XXXXXXX). Found in GA4 Admin > Data Streams > Web.
API SecretCreated in GA4 Admin > Data Streams > Measurement Protocol API secrets.

The GA4 Measurement Protocol sends events server-side, bypassing ad blockers entirely. Create an API secret in your GA4 property's data stream settings.

Snapchat Conversions API

FieldDescription
Access TokenGenerated in Snapchat Business Manager > Business Settings > API Tokens.
Snap Pixel IDYour Snapchat Pixel ID — found in Events Manager > Manage > Pixel ID.

Snapchat Conversions API supports batch event sending for efficient delivery. Events are automatically batched by the gateway.

Pinterest Conversions API

FieldDescription
Access TokenGenerated in Pinterest Business > My Apps > Your App > Generate Token. Requires ads:write scope.
Ad Account IDYour Pinterest Ad Account ID — found in Ads Manager > Ad Account Settings.

Pinterest uses lowercase event names internally. SerpWise automatically maps standard event names (e.g., Purchasecheckout, AddToCartadd_to_cart).

Twitter/X Conversions API

FieldDescription
Access TokenBearer token from Twitter Ads API > Authentication. Requires Ads API access.
Pixel IDYour Twitter/X Pixel ID — found in Events Manager > Event Sources.

Twitter/X Conversions API uses ISO 8601 timestamps and supports hashed email and phone identifiers for attribution matching.

Each integration can optionally require user consent before events are forwarded. When enabled, the gateway checks for consent signals from supported CMPs (OneTrust, Cookiebot, or a custom _sw_consent cookie) and only forwards events when the required consent categories are granted.

Consent CategoryRecommended For
AnalyticsGA4, custom analytics webhooks
MarketingMeta, TikTok, Google Ads, Pinterest, Twitter/X, Snapchat
PersonalizationWebhooks with user-specific data

Configure consent requirements when creating or editing an integration. Events that fail consent checks are logged with status consent_denied in the Event Log.

Testing Connections

After adding an integration, create a test rule with the fire_conversion_event action matching a known URL. Visit the URL and check the Tracking > Event Log sub-tab to verify:

  • The event was sent successfully (green status)
  • The platform accepted the event (no error details)

For Meta, use the Test Event Code field to send events to the Test Events tab without affecting production data.

Enable, Pause, and Delete

  • Pause an integration to temporarily stop sending events without removing credentials. Paused integrations show a muted badge and are skipped during event delivery.
  • Enable a paused integration to resume event delivery.
  • Delete an integration to permanently remove it and its credentials. This cannot be undone.

On this page