Configure telemetry

Make the browser Editor telemetry behavior explicit.

Telemetry is enabled by default. Configure it at Editor construction. The Editor's license identity is configured separately.

Choose telemetry behavior

Disable telemetry explicitly when the deployment must not initialize the telemetry integration:

const superdoc = new SuperDoc({
  selector: '#editor',
  document: '/contract.docx',
  telemetry: { enabled: false },
});

When telemetry is enabled, endpoint selects a custom destination and metadata attaches application-defined context:

const superdoc = new SuperDoc({
  selector: '#editor',
  document: '/contract.docx',
  telemetry: {
    enabled: true,
    endpoint: 'https://telemetry.example.com/v1/events',
    metadata: {
      application: 'contract-review',
      environment: 'production',
    },
  },
});

Do not put document text, comments, names, email addresses, credentials, signed URLs, or other sensitive values in telemetry metadata. Allow the selected endpoint in connect-src and apply the same authentication, retention, and logging policy as any other production integration.

Continue with Secure integration to review every document and metadata boundary.

On this page