Sendgrid is a web and mobile work management platform designed to help teams organize, track, and manage their work.

Authenticating

Sendgrid uses OAuth, a developer-friendly delegated access protocol. Quolum has already connected the necessary wires with Sendgrid. Using a sequence of click-throughs, your organization's administrator allows Quolum to make API calls to Sendgrid without getting access to passwords.

Step 1: Initiate a connection to Sendgrid

Click the Connect button from the Connections card. If you are not an admin, you can invite your organization's Sendgrid admin to make a connection to your Sendgrid organization account. When you click on the Connect button, the web browser will navigate to the Sendgrid login page.

2311

Quolum Catalog: Sendgrid App

Step 2: Log in to Sendgrid

Log in to Sendgrid using your organization's credentials. The exact login mechanism may depend on your Sendgrid plan, and the sign-in mechanism used. You may have corporate SSO such as Azure AD, GSuite, or Okta along with multi-factor authentication. Sometimes you may need to enter an API key and a token, the step by step details of which can be found in Step 3. Once you have successfully logged-in, Sendgrid is going to ask you to grant access to Quolum.

546

Sendgrid Authentication

Step 3: Finding API Keys in Sendgrid

To find your API keys in SendGrid, you can follow these steps:

  • Log in to your SendGrid account at sendgrid.com.
  • Click on the "Settings" option in the left-hand menu.

  • Select the "API Keys" option from the sub-menu.
  • Here, you will see a list of your existing API keys, if any.
  • If you need to create a new API key, click on the "Create API Key" button in the top right corner.
  • Give your API key a name and choose the permissions you want to grant it. Quolum only requires few permissions. Choose "Restricted Access" and then choose Full Access to "Mail Send" and Read Access to "Stats" as shown below

  • Click "Create & View" to create the API key and view its details.
  • You will then see your new API key, along with a "Copy" button that you can use to copy the key to your clipboard.

Step 4: Provide consent to Quolum

The next screen after login into Sendgrid is the consent screen. On this screen, Sendgrid confirms whether you authorize Quolum to access your organization's data.

Step 5: Back to Quolum

Once you have granted access to Quolum on Sendgrid's website, Sendgrid is going to send you back to Quolum's page in Step 1, where you started. The Connect button on the Connections card would now say Reconnect. Reconnect is used to reauthenticate under circumstances where the access has expired.

Under the hood

Using the OAuth protocol, Quolum now has delegated access to your Sendgrid Workspace. The Quolum server, running on Amazon AWS VPC, will be able to make API calls and retrieve feature-level utilization. Later, this data is crunched and available for visualization on the Quolum dashboard.