Navigation click events

Events

Tracking
Events
Navigation click events

Version:

The navigation click event tracks when the site visitor clicks a navigation item in your app, typically on a search results page. For example, when the site visitor clicks a navigation button to move to a different page of search results.

You can send navigation click events by using the widgetNavigationClick function and passing it the navigation click event data object.

The navigation click event data object represents all the required and optional data about the event.

This is the object where you provide data about the event. All this data is sent to Sitecore Search, so make sure to provide the correct data depending on your organization's requirements. Construct the object in the following way:

Provide the ID of the widget ID of the widget that was clicked, data about the navigation item that was clicked, and the URI where the event triggered.
Optionally, you can provide data such as the channel and the language of the page where the event triggered.

Examples

Tip

During development, use your web browser's developer tools to check the payload containing all the event data that is sent to Sitecore.

Example 12. Sending a navigation click event

Here's an example event data object for a navigation click event. The object contains all the required and some optional event data. You can send this event by passing the object to the widgetNavigationClick function:

Browser module

import { widgetNavigationClick } from "@sitecore-cloudsdk/search/browser";
import type { WidgetNavigationClickEventParams } from "@sitecore-cloudsdk/search/browser";

const eventData: WidgetNavigationClickEventParams = {
  widgetId: "rfkid_2",
  pathname: "/rec",
  itemPosition: 1
};

widgetNavigationClick(eventData);

Server module

import type { NextRequest } from "next/server";
import { NextResponse } from "next/server";
import { CloudSDK } from "@sitecore-cloudsdk/core/server";
import { widgetNavigationClick } from "@sitecore-cloudsdk/search/server";
import type { WidgetNavigationClickEventParams } from "@sitecore-cloudsdk/search/server";

export default async function middleware(request: NextRequest) {
  const response = NextResponse.next();

  // Initialize the SDK and the package...

  // Send event:
  const eventData: WidgetNavigationClickEventParams = {
    widgetId: "rfkid_2",
    pathname: "/rec",
    itemPosition: 1
  };

  const widgetNavigationClickResponse = await widgetNavigationClick(request, eventData);
  console.log("Sent widget navigation click event.", widgetNavigationClickResponse);

  return response;
};

For this navigation click event data object, the following payload is sent to Sitecore:

{
  "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
  "client_key": "",
  "language": "EN",
  "page": "rec",
  "pos": "",
  "requested_at": "2026-01-14T11:25:23.325Z",
  "sc_search": {
    "data": {
      "action_cause": "navigation",
      "value": {
        "context": {
          "page": {
            "uri": "/rec"
          }
        },
        "index": 1,
        "rfk_id": "rfkid_2"
      }
    },
    "metadata": {
      "ut_api_version": "1.0"
    }
  },
  "type": "SC_SEARCH_WIDGET_NAVIGATION_CLICK"
}

If you have suggestions for improving this article, let us know!