When Should I Use an API Unlock Instead of Standard Actions?
A standard action like Visit only proves someone clicked. An API unlock (Custom Action Tracking) gives the entry when your own site tells Gleam the action is done. Use it for things like:
- Account signups or completed profiles
- Purchases
- Finished forms or onboarding steps
To set it up on the Business Plan and above:
- On the How to Enter tab, click Add a Way to Enter and choose Custom.
- In the After Visiting dropdown, choose Use Tracking and give it a tracking name, like
Signup. - Add the tracking script from the action to the
<head>of the page where the action happens. - Fire the trigger once the action completes:
Gleam.push(['Signup']);
Tracking can fail with ad blockers and some browsers. Choose Allow Tracking or Question instead and anyone the tracking misses gets a question as a fallback.
Give each Custom Action its own tracking name, or one trigger can unlock several actions. The full scripts are in Custom Action Tracking.