API Reference

Existing Advertisers

Purpose: Guide advertisers who are currently using the legacy Nextdoor pixel and need to migrate to the Universal Pixel framework

Pixel Implementation For Existing Advertisers

Who is this guide for?

This applies to advertisers who have or are currently advertising on Nextdoor and have implemented a Nextdoor pixel in the past. These advertisers are considered to be using the legacy pixel and will need to migrate to the Universal Pixel framework and standards, by doing EITHER the Full Migration or Partial Migration paths below. The following will guide you through the migration process for both.

Why Migrate?

There are many benefits to migrating to the universal pixel framework, as detailed here

Migration Options

  1. Full Migration (updating to the Universal Pixel)
    1. Direct / Manual
    2. Tag Management System
      1. Google Tag Manager
      2. Tealium
  2. Partial Migration (remapping legacy events)

For questions, advertisers should contact their Account Manager (AM).

Nextdoor AMs should collaborate with Solutions Engineers (SolEngs) to resolve any migration issues.

Full Migration

tl;dr: Changing the Legacy Pixel to the Universal Pixel in your website's code

  1. Direct / Manual

    For advertisers who implemented the Nextdoor pixel via a direct / manual implementation (custom coded; not in a tag management system)
    1. Locate your existing Nextdoor base pixel code.
      1. Find where you manually placed the existing Nextdoor base pixel code within your website's HTML. This is typically in the <head> section of your site's pages.
    2. Update the base code.
      1. Visit Nextdoor Ads Manager (NAM) > Assets > Pixels > Install Code, to view pixel installation steps.
      2. In “Step 1: Set up base code”, copy the code snippet. Click “Next” to go to Step 2.
      3. In “Step 2: Set up conversion-event”, make sure to configure ALL of YOUR desired conversion events and their associated URL tracking logic.
      4. CRITICAL STEP: Replace the entire existing/legacy base pixel code in your website’s code, with this new universal pixel base code that you copied.
    3. Remove any legacy conversion pixel code (if applicable)
      1. If you previously installed any legacy conversion pixel code, you may remove these instances from your site.

  2. Tag Management System

    The Nextdoor universal pixel is compatible with popular tag managers like:
    1. Google Tag Manager
    2. Tealium

** Note: As of May 2025, the universal pixel can be implemented in GTM or Tealium using the Custom HTML Tag method. Nextdoor's tag templates for both platforms are scheduled for release in Q3 2025, at which point you can switch from the Custom HTML Tag to the tag template method.

Tag management systems provide significant advantages by streamlining development, speeding up implementation, centralizing tracking, and simplifying pixel troubleshooting. They also improve tracking accuracy through precise control over pixel firing using triggers and variables. However, effective use requires proficiency in the tag management system.

    1. Google Tag Manager

      For advertisers who implemented the Nextdoor pixel via Google Tag Manager (GTM). There are two common implementation methods when using GTM: custom HTML code (copy & pasted the pixel) OR Nextdoor Tag Template. Determine which of these two methods you used to place the pixel and follow the respective instructions below.
      1. Custom HTML Code (copy & pasted the pixel)
        1. Locate your existing Nextdoor base pixel tag in GTM.
          1. Go to your Google Tag Manager workspace.
          2. Click on "Tags" in the left-hand menu.
          3. Find the tag that contains your Nextdoor base pixel code. It might have a name like "Nextdoor Base Pixel" or something similar.
          4. Click on the tag to open its settings.
        2. Update the base code.
          1. Replace the entire existing base pixel code with the new universal pixel base code. You can find the latest base code in the Nextdoor Ads Manager via Assets > Pixels.
          2. You may ignore / skip Step 2 “Set Up Conversion-Event” in your NAM portal, as this conversion event-type logic will be handled by and within GTM.
        3. Locate your existing Nextdoor conversion pixel tag(s).
          1. Go back to GTM to the "Tags" page.
          2. Find the tag(s) that are currently tracking conversion events. They might have names like "Nextdoor Conversion - Lead" or "Nextdoor Conversion - Purchase."
          3. Click on one of these conversion tags to open its settings.
        4. Identify the "CONVERSION" event.
          1. Look for the part of the tag configuration where the event type is specified. It will likely be set to "Conversion".
        5. Change "CONVERSION" to a different, supported event.
          1. Refer to the list of pre-defined acceptable conversion events in Nextdoor
          2. Choose the event that best corresponds to the action you want to track (e.g., "Lead", "Purchase", "Sign Up").
          3. Replace "Conversion" with the name of the new event.
        6. Repeat steps 3-5 for all your Nextdoor conversion pixel tags.
        7. Save your changes to each tag.
        8. Preview your changes.
          1. Click the "Preview" button in the top right corner of your GTM workspace.
          2. Navigate to your website and perform actions that should trigger your Nextdoor pixel events.
          3. Check the GTM Preview pane at the bottom of your screen to ensure your base pixel is firing and your conversion events are firing with the new event names.
        9. Publish your changes.
          1. Once you've confirmed everything is working correctly, click the "Submit" button in the top right corner of your GTM workspace.
          2. Add a descriptive name to your version and click "Publish."
            *Minimum Implementation: Note, if updating all conversion tags is too much work, the bare minimum requirement is to place the updated base pixel on the landing page and update the conversion event on the conversion page to a supported event (or keep PAGE_VIEW and map it to other events within the Nextdoor Ads Manager UI). For each conversion tag, you must change the "Conversion" event to a supported event however in order for tracking to work properly.
      2. Nextdoor Tag Template (from GTM Template Gallery)
        1. Locate your existing Nextdoor conversion event tag(s) in GTM.
          1. Go to your Google Tag Manager workspace.
          2. Click on "Tags" in the left-hand menu.
          3. Find the tag(s) that are using the "Nextdoor Pixel" tag template and are currently tracking conversion events. They might have names like "Nextdoor Event - Lead" or "Nextdoor Event - Purchase."
          4. Click on one of these conversion tags to open its settings.
        2. Identify the "Event Type" field.
          1. Within the tag configuration, look for a field labeled "Event Name". It will likely be set to "CONVERSION".
        3. Change "CONVERSION" to a different, supported event.
          1. Refer to the list of pre-defined acceptable conversion events in Nextdoor
          2. Choose the event that best corresponds to the action you want to track (e.g., "Lead", "Purchase", "Sign Up").
          3. Replace "Conversion" with the name of the new event in the "Event Name" field.
        4. Repeat steps 1-3 for all your Nextdoor conversion event tags using the template.
        5. Save your changes to each tag.
        6. Preview your changes.
          1. Click the "Preview" button in the top right corner of your GTM workspace.
          2. Navigate to your website and perform actions that should trigger your Nextdoor pixel events.
          3. Check the GTM Preview pane at the bottom of your screen to ensure your conversion events are firing with the new event names.
        7. Publish your changes.
          1. Once you've confirmed everything is working correctly, click the "Submit" button in the top right corner of your GTM workspace.
          2. Add a descriptive name to your version and click "Publish."

    2. Tealium

      Important Note: As of May 2025, the Nextdoor tag template in Tealium is being updated to align with the new Universal Pixel framework. This update, which will be live soon, includes renaming "conversion" events to match new event naming conventions for more accurate and standardized tracking. If you use Tealium and wish to upgrade to the Universal Pixel, please contact your Account Manager to involve Nextdoor Solutions Engineers for migration assistance. Further updates and documentation will be provided upon the new template's release.

Partial Migration

tl;dr: No changes to your current pixel in your website's code; just remapping legacy events to those supported by the Universal Pixel

Advertisers who cannot or will not immediately update their base pixel (aka must continue using the legacy base code), can continue tracking conversions that adhere to the new universal pixel events framework; provided they map their current events to the new universal pixel event standards.

Any legacy events need to be migrated to new universal pixel event types to align with the updated structure. This ensures future compatibility. If this applies to you, please update your pixel event types to match the new framework detailed in the chart below.

Legacy EventsUniversal Pixel EventsAction to be taken
ConversionN/AConversion events will need to be migrated to one of the new event types
PurchasePurchase
LeadLead
Sign UpSign Up
N/AAdd to Cart
N/AInitiate Checkout
N/APage View
N/ASearch
N/AView Content
N/AAdd to Wishlist
N/ASubscribe
Custom Conversion 1-10Custom Conversion 1-10 + nickname_Custom conversions need:

- To be audited to see if a new event is a better match
- If none of the new events are a clean match, they need to have a ‘nickname’ added for improved categorization_

Advertisers who choose not to adopt the new universal pixel base code can opt for a "partial migration." This involves retaining their existing legacy code on their site while using Nextdoor's Ads Manager (NAM) UI to map PAGE_VIEW events to other supported events. Essentially, the universal pixel will track page views by default, and advertisers can then use the NAM UI to reconfigure these page view events to represent various standardized conversion events.

Universal Pixel compliancy via Partial Migration

To re-map non-supported legacy events to compliant universal pixel events within the NAM UI, advertisers would generally follow a process that involves:

  1. Generating the Universal Pixel:
    1. Existing advertisers are prompted to use the universal pixel flow, , via Assets > Pixels > Install Code
  2. Reconfiguring Event Types:
    1. Advertisers may need to adjust their current events to be compliant with the new pixel structure.
    2. Skip/Proceed to Step 2 in the flow; legacy events like "Conversion" need to be migrated to one of the new event types - standardized events include "Purchase," "Lead," "Sign Up," "Add to Cart," etc..
    3. In the NAM UI, advertisers can select pre-set standardized conversion event name options to map to specific URLs on their website.
    4. They can specify the conditions of the event that’s mapped to a URL.
  3. Using the Event Manager:
    1. The new pixel will enable use of NAM's Test Events Manager, where teams will have a UI-based pixel configuration flow and diagnostic tool (Note: this is only supported in Chrome browser)
    2. This includes the ability to set up multiple conversion events, and one conversion event mapped to one URL.
  4. Auditing and Updating Custom Events:
    1. If you have custom conversion events (1-10), these need to be audited to see if a new standard event is a better match.
    2. If not, you need to have a ‘nickname’ added for improved categorization.

The universal pixel simplifies event tracking by using a single code deployed once. Event-specific tracking and configuration are then managed within the NAM UI, eliminating the need for multiple unique pixel codes. Therefore, it is essential to routinely review and update your conversion tracking logic (i.e., the "equals" or "contains" conditions that trigger specific conversions).

Important Note: The precise steps for remapping events will vary based on your specific configuration and tools. While your development team can typically handle this implementation, contact your Account Manager for assistance or if you have any questions.