Before getting started with the installation, we recommend reaching out to our support team. This will help ensure everything is set up correctly from the start and help you avoid potential issues.

📌

To install it, you’ll need to:

When the Modified tag sends a request, it messages the Trackingplan Tag with a copy of the request, which then forwards it to the Trackingplan Server.

Watch this video for a step-by-step installation from scratch:

How to Install the Trackingplan Tag

The Trackingplan tag captures GA4 requests and collects messages from modified tags, sending all data to the Trackingplan server for monitoring.

You have 2 options: installing it from the Community Templates, or importing it manually using the .tpl file.

Manual Installation

Import the template into your SSGTM container

Download the template from https://github.com/trackingplan/trackingplan-ssgtm-tag/blob/main/template.tpl
In your SSGTM container, go to Templates → New → Import from file

Select the downloaded template file
Save

Create a new tag using the template:

In your SSGTM container, go to Tags → New

Select the Trackingplan template

Add your Trackingplan ID

Set appropriate trigger rules (typically "All Events”, “All Pages")

Click Save
And don’t forget to publish your container

☝🏻

Using Stape? If your ssGTM container is hosted on Stape, Trackingplan detects this automatically. You only need to add your Trackingplan ID, no manual domain configuration required!

How to modify the tags you want to monitor

This step should be done on all the templates you want to monitor with Trackingplan.

Open the tag template (this works on any tag)

Add the Trackingplan Snippet to the top of the template (see code below)

Remove/Comment the original sendHttpRequest and sendHttpGet methods.

Enable the Send/Receive message permission

Save

And don’t forget to publish your changes

Trackingplan Snippet

/* Trackingplan snippet to be included in on top of templates to be monitored by Trackingplan */
const sendHttpRequest = (url, options, body) => {
    require('addEventCallback')(() => {
        require('sendMessage')('tp_request', { url: url, body: body });
    });
    return require('sendHttpRequest')(url, options, body);
};
const sendHttpGet = function (url, options) {
    require('addEventCallback')(() => {
        require('sendMessage')('tp_request', { url: url });
    });
    return require('sendHttpGet')(url, options);
};
/* End of Trackingplan snippet */

Using Custom domains

💡

Many server-side tagging setups use first-party collection domains instead of the standard endpoints used by analytics platforms. If that's your case, configure your custom domain together with the ssgtm parser ID so Trackingplan can correctly identify and parse those requests.

Trackingplan automatically recognizes requests sent to the standard collection domains used by supported analytics and marketing platforms. Those domains are mapped to destination parsers, which understand the request format of each platform and transform the raw requests into the enriched event format used throughout Trackingplan.

However, if your implementation sends data to a custom collection domain instead of the platform's default one, Trackingplan won’t be able to identify it automatically. In that case, you must configure the custom domain during Trackingplan’s installation.

When configuring a custom domain, you'll need to provide:

The custom domain that your implementation sends requests to (for example, your own collection domain instead of the platform's default endpoint).
The parser ID that tells Trackingplan which platform those requests belong to (for example, ssgtm for a server-side GTM endpoint or tealium for a Tealium Collect endpoint).

The parser value is not the name that will appear in Trackingplan. It is the internal parser identifier that tells Trackingplan how to interpret requests coming from that domain.

For example, imagine your server-side GTM container receives requests at metrics.example.com. Trackingplan doesn't know what kind of requests that domain serves, so you need to tell it:

customDomains: [
  {
    domain:"metrics.example.com",
    parser:"ssgtm"
  }
]

Trackingplan will now treat every request sent to metrics.example.com as a server-side GTM request and parse it using the ssgtm parser.

Some common parser IDs include:

Platform	Parser ID
Server-side Google Tag Manager	`ssgtm`
Stape	`stape`
Tealium	`tealium`
Adobe Analytics	`adobe`
Adobe Target	`adobe_target`
Jentis	`jentis`
Piano	`piano`

These are just some common examples. If you're unsure which parser ID applies to your setup, contact the Trackingplan team, and we'll help you identify the correct one.

How to debug & verify everything is running properly

To ensure everything is running properly, make sure to see the following in your preview mode:

Each time a request is sent from one of your modified tags (1 in the image), there is one from Trackingplan happening in its payload (2 in the image).
For each Incoming Request (3 in the image), there is a matching Trackingplan request (4 in the image).

← Previous

For Apps

Post-Install Warm-Up