Create trigger with the Google Tag Manager API

Creates a trigger in a workspace and returns its triggerId. A pageview trigger without filter fires on every page. A condition compares a variable, such as {{Page URL}}, with a value; the built-in variables of clicks and forms, such as {{Click ID}}, only work once enabled in the workspace, which this toolkit does not do.

Identifier
google_tag_manager_create_trigger

The request

POST https://connect.reportei.com/api/tools/google_tag_manager_create_trigger/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "accountId": "<accountId>",
    "containerId": "<containerId>",
    "workspaceId": "<workspaceId>",
    "name": "<name>",
    "type": "pageview"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
accountIdstringYesAccount id from List accounts.
containerIdstringYesContainer id from List containers: the number in containerId, not the GTM- code of publicId.
workspaceIdstringYesWorkspace id from List workspaces.
namestringYesName of the trigger in Tag Manager.
typestringYesEvent that fires the trigger: pageview, domReady or windowLoaded for page loads, customEvent for a dataLayer event, click for any element, linkClick for links only, formSubmission, historyChange, timer, scrollDepth, elementVisibility, youTubeVideo, jsError, init or consentInit.Values: pageview, domReady, windowLoaded, customEvent, click, linkClick, formSubmission, historyChange, timer, scrollDepth, elementVisibility, youTubeVideo, jsError, init, consentInit
filterarrayNoConditions that must all be true for the trigger to fire.
customEventFilterarrayNoOnly customEvent: conditions on the event, such as {{_event}} equals the event name pushed to the dataLayer.
autoEventFilterarrayNoOnly the triggers that listen to the page, such as linkClick, formSubmission and timer: conditions that enable the listener on a page, usually on {{Page URL}}.
waitForTagsobjectNoOnly formSubmission and linkClick: true holds the submit or the link until the tags fire.
waitForTagsTimeoutobjectNoOnly formSubmission and linkClick: how long to hold, in milliseconds.
checkValidationobjectNoOnly formSubmission and linkClick: true fires the tags only if the submit or the click is not canceled by the page, such as by a failed validation.
eventNameobjectNoOnly timer: name of the event the timer pushes.
intervalobjectNoOnly timer: milliseconds between events.
limitobjectNoOnly timer: how many events to push at most.
parameterarrayNoOther settings of the trigger, such as the scroll percentages of a scrollDepth trigger or the element of an elementVisibility trigger.
notesstringNoNotes about the trigger.

Supported connections

Your customer connects their Google Tag Manager account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/google_tag_manager, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/google_tag_manager_create_trigger. It becomes your agent's tool definition with no conversion.

Other Google Tag Manager tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.