Get started
Before being able to use Zaraz, it is recommended that you proxy your website through Cloudflare. Refer to Set up Cloudflare for more information. If you do not want to proxy your website through Cloudflare, refer to Use Zaraz on domains not proxied by Cloudflare.
You can add new third-party tools and load them into your website through the Cloudflare dashboard.
- Log in to the Cloudflare dashboard ↗, and select your account and website.
- Select Zaraz from the side menu.
- If you have already added a tool before, select Tools Configuration > Third-party tools and click on Add new tool.
- Choose a tool from the tools catalog. Select Continue to confirm your selection.
- In Set up, configure the settings for your new tool. The information you need to enter will depend on the tool you choose. If you want to use any dynamic properties or variables, select the
+
sign in the drop-down menu next to the relevant field. - In Actions setup the actions for your new tool. You should be able to select Pageviews, Events or E-Commerce 1.
- Select Save.
Zaraz relies on events, triggers and actions to determine when to load the tools you need in your website, and what action they need to perform. The way you configure Zaraz and where you start largely depend on the tool you wish to use. When using a tool that supports Automatic Actions, this process is largely done for you. If the tool you are adding doesn't support Automatic Actions, read more about configuring Custom Actions.
When using Automatic Actions, the available actions are as follows:
- Pageviews - for tracking every pageview on your website
- Events - For tracking calls using the
zaraz.track
Web API - E-commerce - For tracking calls to
zaraz.ecommerce
Web API
If you need to programmatically start actions in your tools, Cloudflare Zaraz provides a unified Web API to send events to Zaraz, and from there, to third-party tools. This Web API includes the zaraz.track()
, zaraz.set()
and zaraz.ecommerce()
methods.
The Track method allows you to track custom events and actions on your website that might happen in real time. The Set method is an easy shortcut to define a variable once and have it sent with every future Track call. E-commerce is a unified method for sending e-commerce related data to multiple tools without needing to configure triggers and events. Refer to Web API for more information.
If you suspect that something is not working the way it should, or if you want to verify the operation of tools on your website, read more about Debug Mode and Zaraz Monitoring. Also, check the FAQ page to see if your question was already answered there.
Users and companies have developed plugins that make using Zaraz easier on specific platforms. We recommend checking out these plugins if you are using one of these platforms.
- Beetle Tracking ↗ - Integrate Zaraz with your WordPress WooCommerce website to track e-commerce events with zero configuration. Beetle Tracking also supports consent management and other advanced features.
-
Some tools do not supported Automatic Actions, see the section about Custom Actions if the tool you are adding doesn't present Automatic Actions. ↩