Docs

Testing

Testing is an important part of every application. Each framework may require a slightly different setup. If you're having trouble getting testing to work properly, reach out to support.

Testing with one time passcodes

To avoid sending an email or SMS message with a one time passcode (OTP) during testing, you can use a fake email address or phone number that has a fixed code. Read the complete documentation here.

Testing Tokens

Testing Tokens allow you to bypass bot detection mechanisms that protect Clerk applications from malicious bots, ensuring your test suites run smoothly. Without Testing Tokens, you may encounter "Bot traffic detected" errors in your requests.

Note

While you can manually implement the following logic in your test suite, Clerk provides Playwright and Cypress integrations that handle this automatically.

Obtained via the Backend API, Testing Tokens are short-lived and valid only for the specific instance for which they are issued. Testing Tokens are only available in development instances.

Once retrieved, include the token value in the __clerk_testing_token query parameter in your Frontend API requests. For example, a sign-up request using a Testing Token would look like this:

POST https://happy-hippo-1.clerk.accounts.dev/v1/sign_ups?__clerk_testing_token=1713877200-c_2J2MvPu9PnXcuhbPZNao0LOXqK9A7YrnBn0HmIWxy

For more information, feedback or issues, visit the @clerk/testing package.

Feedback

What did you think of this content?

Last updated on