useTelemetryDeck()

useTelemetryDeck() is a client hook that returns a singleton TelemetryDeck SDK instance.

Use it to track custom events from custom components.


"use client";
 
import { useTelemetryDeck } from "@/hooks/useTelemetryDeck";
 
export function DownloadButton() {
  const telemetryDeck = useTelemetryDeck({
    appID: "your-telemetrydeck-app-id",
    clientUser: "anonymous",
  });
 
  async function handleClick() {
    try {
      await telemetryDeck.signal("downloadButtonClicked", {
        source: "hero",
      });
    } catch (error) {
      console.error("TelemetryDeck custom event tracking failed", error);
    }
  }
 
  return <button onClick={handleClick}>Download</button>;
}

Hook options

Hook options match TelemetryDeck SDK options.

Property	Value	Description
`appID`	`string`	Your TelemetryDeck App ID. Required.
`clientUser`	`string`	Stable user identifier. Use `anonymous` for anonymous tracking.
`target`	`string`	Optional custom backend endpoint.
`sessionID`	`string`	Optional session identifier.
`salt`	`string`	Optional salt used for hashing user identifiers.
`testMode`	`boolean`	Enables test mode for local verification.
`store`	`StorageLike`	Optional custom storage implementation.
`subtleCrypto`	`SubtleCrypto`	Optional custom crypto implementation.