Docs

Appearance

Privacy options ​

By default, the Capture widget collects user interactions and network requests to help debug issues. Depending on your application, some of this data might include sensitive information that you don’t want to log.

Some types of sensitive data are never captured. You can learn more about this on the security page.

You can customise what gets recorded by using the privacyOptions configuration. Filtering takes place entirely in the browser—sensitive data is never sent to Capture servers.

Configuration ​

You can pass custom privacyOptions when initialising the widget:

js
window.captureOptions = {
  captureKey: "YOUR_CAPTURE_KEY",
  privacyOptions: {
    requestBody: "all",
    responseBody: "all",
    requestHeader: "all",
    responseHeader: "all",
    elementName: "auto",
  },
};

requestBody ​

Controls whether the body of network requests is captured.

Possible values:

  • all (default) – Request bodies are captured for all network events
  • none – Request bodies are never captured
  • on-error-only – Captured only for requests that return an error status code

responseBody ​

Controls whether the body of network responses is captured.

Possible values:

  • all (default) – Response bodies are captured for all network events
  • none – Response bodies are never captured
  • on-error-only – Captured only for responses with an error status code

requestHeader ​

Controls which headers from network requests are included.

Possible values:

  • all (default) – Header names and values are captured
  • key-only – Only header names are captured, not values
  • none – No headers are captured
  • on-error-only – Captured only for requests with an error status code

responseHeader ​

Controls which headers from network responses are included.

Possible values:

  • all (default) – Header names and values are captured
  • key-only – Only header names are captured, not values
  • none – No headers are captured
  • on-error-only – Captured only for responses with an error status code

elementName ​

For interaction events, Capture tries to assign a friendly name to the element (for example, using a label or button text). You can override this behaviour.

Possible values:

  • auto (default) – Let Capture choose a name based on markup
  • tag-only – Use only the HTML tag name, like button or input