SDK telemetry
Opt-in SDK usage telemetry — what is collected, how to enable it, and how Wocha uses the data
Wocha SDKs support opt-in telemetry to help you monitor integration health and help us improve the SDKs. Telemetry is disabled by default and does not collect user data, tokens, credentials, or other personally identifiable information (PII).
What is collected
When enabled, SDKs send aggregated usage metrics to your Wocha tenant approximately every five minutes and on process exit:
| Field | Description |
|---|---|
| SDK version | Package version (e.g. 0.1.0) |
| Framework | typescript, nextjs, etc. |
| Node.js version | Runtime version (e.g. v20.11.0) |
| Auth method | High-level method (api_key, oauth) — not credentials |
| Request counts | Number of SDK/API calls in the batch |
| Error counts | Number of failed SDK/API calls in the batch |
The Next.js SDK additionally reports:
| Field | Description |
|---|---|
| Middleware invocations | How often auth middleware ran |
| Route handler calls | Auth route handler invocations (/api/auth/*) |
| Session refresh attempts | Token refresh attempts |
| Session refresh successes | Successful refreshes |
What is not collected
- User IDs, emails, or profile data
- Access tokens, refresh tokens, API keys, or webhook secrets
- Request or response bodies
- IP addresses (beyond what your infrastructure already logs)
- Custom application data
How to opt in
Set the environment variable in the process running your SDK:
Ensure your app also has a valid management API key (WOCHA_API_KEY) and tenant/API URL configured so batches can be delivered to:
Telemetry never throws or blocks authentication flows — failures are silently ignored.
How to opt out
Leave WOCHA_TELEMETRY unset, or set it to any value other than true:
No telemetry code sends data unless explicitly enabled.
Data retention
Telemetry batches are retained for 90 days per tenant, then automatically purged. Aggregates may be kept longer in anonymised form for SDK reliability reporting.
You can view integration health derived from telemetry (alongside auth logs and webhooks) on the Developer page in the Wocha Console.
Why it helps
Opt-in telemetry enables:
- Faster issue resolution — correlate SDK version and error rates when you contact support
- Proactive alerts — surface misconfiguration and integration health in the Console Developer page
- Better SDK development — prioritise fixes and features based on real-world framework usage
If you have questions about telemetry or data processing, see our DPA and security practices.