How it works

With your instance deployed, redirect users to:

https://YOUR_HANDSHAKE_INSTANCE_URL/auth/HANDLER_ID/redirect

Where HANDLER_ID is either workos or the value passed to the optional id argument of the WorkOS() factory. (See Options below.)

Handshake will take each user through the WorkOS OAuth flow and before sending them back to you, at the URL specified by the callback_uri query parameter.

Options

Modify your app/options.ts file to include the WorkOS() handler like so:

import { WorkOS, HandshakeOptions } from "handshake";
 
const config: HandshakeOptions = {
  handlers: [
    WorkOS({
      clientId: string,
      clientSecret: string,
    });
  ],
}
 
// ...

Adapted from next-auth.

Consult the reference to learn about HandshakeOptions.

Troubleshooting

Facing an issue making WorkOS work? Open an issue on GitHub to get help.