Sanity Library Reference Docs
    Preparing search index...

    Function WorkflowTelemetryProvider

    • Wrap an App SDK application (inside SanityApp / the SDK providers) to give the workflow hooks a telemetry channel. Descendants — including useWorkflowTelemetry() for createEngine({telemetry}) — read the shell's logger via the standard @sanity/telemetry React context; apps that never mount this provider emit nothing (the context defaults to the no-op logger).

      Replicates the App SDK's own telemetry policy (hostname gate, account consent, batch transport, tagged as sanity.workflows.sdk.telemetry.* rather than the host app's own tags) as a copy that can drift from it, because the SDK exposes no provider or logger of its own; delete this module and consume the SDK's provider once it ships one. Renders children bare, without a store, on an ineligible host or before the app's client resolves an auth token. The store is created during render, not in an effect, so descendants' effects — including session-start telemetry — are never dropped.

      Each event's own context keys are kept beside the shell context keys. When an event sets one of the shell keys (surface, packageVersion, environment, userAgent, projectId, dataset), the shell value wins.

      Parameters

      • __namedParameters: { children: ReactNode }

      Returns ReactElement