Deep Link

Capture deep link navigation as breadcrumbs in your React Native application.

(Available in version 8.8.0 and above)

Import name: Sentry.deeplinkIntegration

The deeplinkIntegration automatically captures breadcrumbs when your app receives deep links via React Native's Linking API. It tracks both cold start URLs (the link that opened the app) and warm open URLs (links received while the app is running).

Copied
import * as Sentry from "@sentry/react-native";

Sentry.init({
  dsn: "___PUBLIC_DSN___",
  integrations: [Sentry.deeplinkIntegration()],
});

Each deep link creates a breadcrumb with:

  • category: deeplink
  • type: navigation
  • data.url: the deep link URL

When sendDefaultPii is false (the default), the integration sanitizes URLs before recording them:

  • Query strings are removed
  • Path segments that look like IDs (numeric values, UUIDs, hex strings of 8+ characters) are replaced with <id>

For example, myapp://user/123/profile?token=xyz becomes myapp://user/<id>/profile.

Set sendDefaultPii: true in your Sentry.init() options to capture the full, unsanitized URL.

Previous
Unhandled Promise Rejections
Next
Spotlight
Was this helpful?
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").