How it works

With your instance deployed, simply redirect users to:

https://YOUR_HANDSHAKE_INSTANCE_URL/auth/HANDLER_ID/redirect

Where HANDLER_ID is either mailxpert or the value passed to the optional id argument of the Mailxpert() factory. (See Usage below.)

Handshake will take the user through the Mailxpert OAuth flow and redirect them back to the URL specified by the callback_uri query parameter.

Usage

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

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

Consult the reference to learn about HandshakeOptions.

Troubleshooting

Having an issue making Mailxpert work? Open an issue in our Github repo to get help from our team.