SendGrid connector

• Starter
• Business
• Enterprise
• On-Premise
• Add-on

Overview

Etlworks SendGrid connector allows the fastest and easiest way to connect to real-time SendGrid data. The connector works just like any other database connector.

Etlworks partnered with CData to provide access to SendGrid using industry-standard JDBC protocol. Read about CData SendGrid JDBC connector.

When to use SendGrid connector

Use this connector to create Flows that extract data and load data into SendGrid.

Prerequisites

Enable the SendGrid connector for Etlworks account. Contact support@etlworks.com to enable the connector.

Create a Connection

You can create a Connection in just two steps, and they are the following:

Step 1. In the Connections window, click +, and type in sendgrid.

Step 2. Enter the Connection parameters:

• API Key: the API Key. Read how to manage SendGrid API Keys. 
• User: the user name.
• Password: the password.

Use Other Parameters to specify the Connection string options. Read about available Connection string options.

Work with SendGrid

SendGrid Data Model

The connector models SendGrid APIs as relational tables, views, and stored procedures. Most tables, views, and stored procedures are defined in schema files, which are simple, text-based configuration files.

However, the Recipients table is dynamic: The driver connects to SendGrid and gets the metadata for this table by calling the appropriate Web services. Any changes you make to the custom filters you define for Recipients are available when you connect; you can use these custom filters as columns in the WHERE clause. These custom filters are surfaced in the CustomFields table.

Read about the data model.

Stored procedures

Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the data retrieval is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return a dataset that contains the collection of tuples that constitute the response.

Read about available stored procedures in the data model.  

To call stored procure from the SQL Flow or Before/After SQL, use EXEC sp_name params=value.

Example:

EXECUTE my_proc @second = 2, @first = 1, @third = 3;

SQL Compliance

The connector supports several operations on data, including querying, deleting, modifying, and inserting.

Read about SQL Compliance.

Extract data from SendGrid

Extracting data from SendGrid is similar to extracting data from the relational database.

Here are the steps on how you can extract data from SendGrid:

Step 1. Create SendGrid Connection which will be used as a source (FROM).

Step 2. Create a destination Connection, for example, a Connection to the relational database, and if needed, a Format (Format is not needed if the destination is a database or well-known API).

Step 3. Create a Flow where the source is a database and the destination is a Connection created in step 2, for example, a relational database.

Step 4. Add a new source-to-destination transformation.

Step 5. Select the SendGrid Connection created in step 1 as a source Connection and select the data object you are extracting data from.

Step 6. Select TO Connection, Format (if needed), and object (for example, database table) to load data into.

Step 7. Click MAPPING and optionally enter Source query (you don't need a query if you are extracting data from the SendGrid data object unconditionally).

Step 8. Optionally define the per-field Mapping.

Step 9. Add more transformations if needed.

Load data in SendGrid

Loading data in SendGrid is similar to loading data into a relational database.

Here are the steps on how you can load data in SendGrid:

Step 1. Create a source Connection and a Format (if needed).

Step 2. Create a destination SendGrid Connection.

Step 3. Create a Flow where the destination is a database.

Step 4. Add new source-to-destination transformation.

Step 5. Select FROM and TO Connections and objects (also a FROM Format if needed).

Step 6. Optionally define the per-field Mapping.

Step 7. Add more transformations if needed.

Browse data in SendGrid

You must have SendGrid Connection to browse objects and run SQL queries.

Use the Etlworks Explorer to browse data and metadata in SendGrid as well as execute DML and SELECT queries against the SendGrid Connection.