SendGrid Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium SendGrid connector.

SendGrid is an email API service simplifying the process of sending and receiving emails efficiently.

This topic describes how to authenticate to SendGrid and configure any necessary connection properties in the SendGrid connection connector.

Prerequisites

Obtaining an API Key

To obtain an API key, follow the steps below:

  1. Log into SendGrid.

  2. Click Settings.

  3. Click API keys.

  4. Click Create API Key.

  5. Choose the Permissions the API Key should have, either Full Access or Restricted Access. The API key is then displayed.

NOTE: If you want access to Email events, you must purchase the Email Activity History add-in of SendGrid. If using a Restricted Access key, you must give it the messages.read and email_activity.read scopes.


Connection Configuration

Each connection property available in the SendGrid connector is explained below.


Connection Name

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.


API Key

The API key of the currently authenticated user.

Note that it is a manadatory parameter to authenticate through SendGrid connector.


Schema

The type of schema to use.

The schemas available are NMC and Legacy.


Enable SSL

Option for creating the connection with SSL enabled.

Upload Keystore File

Option to upload keystore file.


Advanced Configurations

This section contains additional configuration parameters.

Include CustomFields

A boolean indicating if you would like to include custom fields in the column listing.

Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.


Add Configuration: Additional properties can be added using this option as key-value pairs.


After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.

Top