Adding a Custom Tool

To add a tool that's not included in our third-party tools library, you can load it as custom HTML or as a custom IMG tag with the following steps:

  1. On the third-parties page, click the plus sign at the bottom of the page.
  2. After clicking the plus sign, a third-party catalog will open. Click the "Custom Tool +" button at the left side of the screen, under the list of tools categories.
  3. Give the new tool a descriptive name.
  4. Choose between Custom HTML or Custom IMG tag:
    • Choose a Custom IMG tag when the tool you are adding is using an <img> tag. This is a basic "pixel" (e.g. collects data simply by making the browser request an image from a particular URL). This method, while less common, is more performant.
    • Choose Custom HTML when the tool you are adding is using a <script> tag. Most third-party tools call this method "manual implementation". Zaraz will add the script to the page as it is.
  5. You will then be directed to adding a tool wizard. On step two, "Optimizations", you can toggle the default optimization off, and choose the Timing in which Zaraz should load your script.
    • Smart defer - load your tool using a smart deferring mechanism (recommended).
    • Page load - load your tool once the page is loaded. The browser could still be busy with rendering and loading additional scripts.
    • Immediate - load your tool as early as possible on your page, potentially blocking the rest of the rendering.
  6. As a final step, you need to configure the first event that you wish to use in order to load the new tool. For most tools, it will be a simple pageview event, for which Zaraz offers a preset configuration. We recommend using the pre-filled format that you see. When defining an event for a custom tool, you should make sure to include:
    1. Event Name - the name of the event that will be used internally in the Zaraz dashboard.
    2. Trigger - a set of rules that need to apply in order for Zaraz to trigger the event (e.g. the loading of the script you will add). Zaraz has a preset trigger for pageviews that will be automatically used.
    3. The script tag, or the URL of the image - simply paste your <script> or the image URL inside the text box and click next to complete the process. The URL is the content of the src attribute of the <img> tag, without quotes.
  7. The new tool you just added will be loaded on your website only after the changes you've made are published. Find more information about previewing and publishing in the "How to preview, publish and revert?" article.

Lastly, if you are missing a tool, we would appreciate it if you could submit a request to add it to our third-party tools.