SendGrid Setup (Transactional Email Support)

What is SendGrid used for?

By default, SendGrid is disabled and not a required dependency to host and use the UserWise service. However, without SendGrid enabled team members will be unable to use operations like:

• Account Invite Emails

• Account Confirmation Emails

• Password Reset Emails

All of the above emails may be circumvented – thus rendering SendGrid unnecessary – by manually managing users through the console.

How do I enable SendGrid?

To enable SendGrid for your self-hosted UserWise environment, you will need an API Key & an appropriately authorized sending email address.

Create a new API Key

1. Navigate to the API Keys page within your SendGrid dashboard.

2. Start the process of adding a new API Key

   1. Name your API Key anything _{(preferably something indicating UserWise’s access)}

   2. Set permissions to: Restricted Access

   3. Ensure full permissions for the following operations: Mail Send & Template Engine

3. Take note of the API key, as it will be used below.

Authorize a Sending Email

Sending emails can be authorized through either of SendGrid’s authorization mechanisms: Domain Authorization or Single Sender Verification. The only affecting variable is that the sending email set has authorization to send emails from your account.

Setting the variables

Now that we have our API Key and Sending Email noted, we can set the appropriate variables within our credentials.yml.enc file.

1. Run: ./bin/edit_credentials from within your self-hosted repository

2. Update the sendgrid_api_key key to your noted API Key

3. Update the sendgrid_support_email key to your Authorized Sending Email

4. Finally, run ./bin/deploy to deploy a new release of UserWise