Compatibility keys
Compatibility presets and observe/replace modes are planned. The live feature is manual compatibility keys.
Running another tracker alongside Plandalf
Keep native Plandalf globals, cookies, and metadata keys separate from the other tracker. Do not use tolt_referral as a native compatibility name while Tolt is still running: a Plandalf token is not a Tolt ID. The Tolt setup guide shows how to carry Tolt properties without overwriting them.
Live settings
Under Affiliates -> Settings -> Compatibility keys, configure:
- additional link parameters
- a browser global name
- a cookie name
- a Stripe metadata key
In code, use flat referral options:
plandalf("configure", {
referral: {
params: ["via", "ref", "partner"],
global: "my_affiliate_referral",
cookie: "my_affiliate_referral",
metadataKey: "my_affiliate_referral",
decorate: ["buy.stripe.com", "checkout.example.com"],
},
});Or use script attributes:
<script
src="https://acme.plandalf.dev/js/plandalf-track.js"
data-config-referral-params="via,ref,partner"
data-config-referral-global="my_affiliate_referral"
data-config-referral-cookie="my_affiliate_referral"
data-config-referral-metadata-key="my_affiliate_referral"
async
></script>The nested referral.compat object and data-config-referral-compat attributes are not live API.
Stripe metadata key
The compatibility metadata key is read by the native Stripe source when Stripe events contain matching metadata. It is also exposed by the referral handle’s metadata() helper.
Planned
Preset tool profiles, old-script detection, shimmed browser APIs, lead/signup adoption and importer workflows are planned.