This is a toy app to act as an example of how to fulfill password reset requests yourself, using your own email provider and password reset form. This example app is very basic and is not production ready.

Not only will this provide better visibility into potential deliverability issues, but this also lets you brand emails to better match your software (instead of using Keygen's default branding).

Handling password reset logic yourself consists of 2 things:

1. Creating a small webhook server that listens for the user.password-reset webhook event, and then sends the included password reset token to the user's email.
2. Creating a small HTML web page that accepts the password reset token to fulfill the password reset request using our API.

This example uses Postmark to send emails, but you're free to use another provider.

First up, configure a couple application variables. You can find these under your account settings. You must configure these.

# Your Postmark API key for sending email.
POSTMARK_SERVER_API_KEY="xxx"

# The address you're sending mail from.
POSTMARK_FROM_ADDRESS="[email protected]"

# Your Keygen account's DER encoded Ed25519 verify key, used
# for verifying webhooks came from Keygen.
KEYGEN_VERIFY_KEY="MCowBQYDK2VwAyEA6GAeSLaTg7pSAkX9B5cemD0G0ixCV8/YIwRgFHnO54g="

# Your Keygen account ID.
KEYGEN_ACCOUNT_ID="1fddcec8-8dd3-4d8d-9b16-215cac0f9b52"

# The scheme for your server i.e. https.
SCHEME='https'

# The hostname of the server i.e. your domain.
HOST='acme.example'

# The port to run the server on.
PORT=3000

Next, install dependencies with yarn:

yarn

Then start the app:

yarn start

Lastly, open the app:

open http://localhost:8080

Using ngrok, create a secure tunnel to your local server. You can download ngrok here.

ngrok http 8080

Please ensure your local server is running.

Using the generated ngrok HTTPS URL above, create a new webhook endpoint. Subscribe your webhook endpoint to the user.password-reset event.

https://YOUR_NGROK_TUNNEL_ID.ngrok.io/webhooks

Note the /webhooks path.

Visit the root of your local server and fill out the password reset request form.

open http://localhost:8080/reset

Alternatively, you can use curl to request a password reset. Be sure to include deliver: false so that Keygen doesn't send an email to the user as well.

curl -X POST https://api.keygen.sh/v1/accounts/YOUR_KEYGEN_ACCOUNT_ID/passwords \
  -d '{
        "meta": {
          "email": "[email protected]",
          "deliver": false
        }
      }'

This will trigger a user.password-reset event to be sent to your webhook endpoint. We will not send an email to the user, so deliverability is on you.

You can view your account's webhook event logs here.

After fulfilling the password reset request, you can test the user's new credentials by generating a user token.

curl -X POST https://api.keygen.sh/v1/accounts/YOUR_KEYGEN_ACCOUNT_ID/tokens \
  -u [email protected]:YOUR_NEW_PASSWORD

Reach out at [email protected] if you have any questions or concerns!