track()
The _satellite.track() method allows you to trigger a Direct call rule.
IMPORTANT
Adobe considers
_satellite.track() a legacy implementation method. While it is still fully supported, Adobe strongly recommends using more modern implementation practices, such as the Adobe Client Data Layer, which is the recommended approach for new implementations.If you opt to use
_satellite.track() on your site, guard every call so that your site is not tightly coupled to the tag library. If not guarded, removing the tag property in the future causes all references to the _satellite object to throw errors._satellite.track(identifier: string, detail?: unknown ): void;
When you call _satellite.track() using the identifier configured in the tags UI, that rule is immediately triggered. Calling this method only acts as the rule event; the rule’s conditions still apply before executing the rule’s actions. Multiple direct call rules can use the same identifier, allowing you to trigger all of those rules at once using a single _satellite.track() call. Each triggered rule still checks its own conditions before taking action, even if multiple rules share the same identifier.
Available fields
The _satellite.track() method supports two arguments:
Name
Type
Required
Description
identifierstringYes
The direct call rule identifier. You set this identifier when configuring the rule in the tags UI.
detailunknownNo
An optional payload containing any desired information. When configuring a rule, you can access the payload using
event.detail (custom code) or %event.detail% (text fields that support data element notation).// Trigger rules with the identifier 'example'
if (window._satellite?.track) {
_satellite.track('example');
}
// Trigger a direct call rule with an optional payload that your tag rule can use
_satellite.track('contact_submit', { name: 'John Doe' });
// When configuring the rule, access the payload field using:
// event.detail.name (custom code block) or
// %event.detail.name% (data element)
recommendation-more-help
1ae86b30-e55e-49c1-ab11-9d0356a5f3e1