Troubleshooting
If you’re having trouble setting up the SDK, read on!
Common issues​
Timeouts​
The recordSDK won’t work unless it is using a valid API key and is running against a domain that has been whitelisted for that key. For example, if your website’s domain is “sample.com” and your API key does not have “sample.com” added as a domain, clicking the element the SDK is tied to won’t work and you’ll see an error in the console.
If you want to develop against localhost, use the sandbox API key that’s automatically created when you set up your developer account.
Check out our Loom explanation for more information on how to fix.
Missing UI​
In some contexts like Shopify apps, the iframe that loads the SDK can be hidden. You can fix it by manually applying the style
div#loom-sdk-record-overlay-shadow-root-id {
display: block !important;
}
X-Frame-Options​
The following error message occurs when the referer header is missing in SDK requests:
Refused to display 'https://www.loom.com/' in a frame because it set 'X-Frame-Options' to 'deny'
Ensure the referer header is present with the value set to the origin of the page (this should match one of the domains associated with your application). Adding the following meta tag to your HTML template is one way to resolve this issue:
<meta name="referrer" content="origin">
Content-Scurity-policy (CSP)​
# Example 1:
Refused to frame 'https://www.loom.com/' because it violates the following Content Security Policy directive...
# Example 2:
Content Security Policy: The page’s settings blocked the loading of a resource
When an error message like the above appears, it's likely that the CSP needs to be updated. See the documentation & examples on what needs to be added to the content-security-policy
isSupported Deprecation Warning in v3.0.0+​
With the release of v3.0.0, isSupported can only be imported from its own bundled module at @loomhq/record-sdk/is-supported.
Importing isSupported from @loomhq/record-sdk will be deprecated.
// v3.0.0 and after
import { isSupported } from "@loomhq/record-sdk/is-supported";
// Before v3.0.0
import { isSupported } from "@loomhq/record-sdk/is-supported";
// OR
import { isSupported } from "@loomhq/record-sdk";