Clerk Node.js SDK
Create a Clerk application
You need to create a Clerk application in the Clerk Dashboard before you can set up Clerk Node.js. For more information, see the setup guide.
Install @clerk/clerk-sdk-node
Once a Clerk application has been created, you can install and then start using Clerk Node.js in your application. An ESM module for the Clerk Node SDK is available under the @clerk/clerk-sdk-node npm package.
npm install @clerk/clerk-sdk-nodeyarn add @clerk/clerk-sdk-nodepnpm add @clerk/clerk-sdk-nodeSet environment variables
Below is an example of an .env.local file.
Pro tip! If you are signed into the Clerk Dashboard, your Secret Key should become visible by clicking on the eye icon. Otherwise, you can find your keys on the API keys page in the Clerk Dashboard.
CLERK_PUBLISHABLE_KEY=YOUR_PUBLISHABLE_KEY
CLERK_SECRET_KEY=YOUR_SECRET_KEYAvailable methods
All resource operations are mounted as sub-APIs on the clerkClient object. To access the resource operations, you must first instantiate a clerkClient instance.
Multi-session applications
If Clerk is running in multi-session mode, it's important to ensure your frontend sends the Session ID that is making the request.
Our middleware will look for a query string parameter named _clerk_session_id. If this parameter is not found, the middleware will instead choose the last active session, which may be subject to race conditions and should not be relied on for authenticating actions.
Connect/Express middlewares
The Clerk Node SDK offers two middlewares to authenticate your backend endpoints.
Error handling
Node SDK functions throw errors (ClerkAPIResponseError) when something goes wrong. You'll need to catch them in a try/catch block and handle them gracefully. For example:
try {
const res = await someBackendApiCall()
} catch (error) {
// Error handling
}Feedback
Last updated on