Already have an account? Sign in

SendGrid Core (v1)

SendGrid Core integration summary

Stitch’s SendGrid Core integration replicates data using theSendGrid v3 API. Refer to theSchema section for a list of objects available for replication.

SendGrid Core feature snapshot

A high-level look at Stitch's SendGrid Core (v1) integration, including release status, useful links, and the features supported in Stitch.

Connecting SendGrid Core

SendGrid Core setup requirements

To set up SendGrid Core in Stitch, you need:

• Access to the objects you want to replicate from SendGrid. This is required to grant the required permissions to the API key Stitch uses to connect to your SendGrid account.

  For example: If you want to replicate campaign data, you need to be able to access campaigns in your SendGrid account.

Step 1: Create a SendGrid general API key for Stitch

Note: You can’t assign an API key greater permissions than you currently have in SendGrid.

1. Sign into your SendGrid account.
2. On the dashboard page, clickSettings > API Keys.
3. ClickCreate API Key.
4. In theAPI Key Name field, enter a name for the key. For example:Stitch API key
5. In theAPI Key Permissions section, selectRestricted Access.
6. In theAccess Details section, enable the following:
   • Email Activity - Read Access
   • Marketing Campaigns - Full Access (Note: SendGrid doesn’t currently provide a read-only level for this object.)
   • Suppressions - Read Access
   • Template Engine - Read Access
   • Tracking - Read Access
7. ClickCreate & View.
8. The API key will display.Copy the key before closing the page, as SendGrid won’t display it again.

Step 2: Add SendGrid Core as a Stitch data source

1. Sign into your Stitch account.

2. On the Stitch Dashboard page, click theAdd Integration button.

3. Click theSendGrid Core icon.

4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

   For example, the name “Stitch SendGrid Core” would create a schema calledstitch_sendgrid_core in the destination.Note: Schema names cannot be changed after you save the integration.

5. In theSendGrid API Key field, paste your SendGrid API key.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your SendGrid Core integration. This means that dataequal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond SendGrid Core’s default setting of1 year. For a detailed look at historical replication jobs, check out theSyncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In theReplication Frequency section, you’ll create the integration’sreplication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

SendGrid Core integrations support the following replication scheduling methods:

• Replication Frequency

• Anchor Scheduling

• Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up SendGrid Core, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, aPending status indicates that Stitch is in the process of scheduling the initial replication job for the integration.This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

SendGrid Core table reference

blocks.email = bounces.email

blocks.email = contacts.email

blocks.email = groups_members.email

blocks.email = invalids.email

blocks.email = lists_members.email

blocks.email = segments_members.email

blocks.email = spam_reports.email

bounces.email = blocks.email

bounces.email = contacts.email

bounces.email = groups_members.email

bounces.email = invalids.email

bounces.email = lists_members.email

bounces.email = segments_members.email

bounces.email = spam_reports.email

campaigns.list_ids = lists_all.id

campaigns.segment_ids = segments_all.id

campaigns.segment_ids = segments_members.segment_id

campaigns.suppression_group_id = groups_members.group_id

contacts.email = blocks.email

contacts.email = bounces.email

contacts.email = groups_members.email

contacts.email = invalids.email

contacts.email = lists_members.email

contacts.email = segments_members.email

contacts.email = spam_reports.email

groups_members.email = blocks.email

groups_members.email = bounces.email

groups_members.email = contacts.email

groups_members.email = invalids.email

groups_members.email = lists_members.email

groups_members.email = segments_members.email

groups_members.email = spam_reports.email

groups_members.group_id = campaigns.suppression_group_id

invalids.email = blocks.email

invalids.email = bounces.email

invalids.email = contacts.email

invalids.email = groups_members.email

invalids.email = lists_members.email

invalids.email = segments_members.email

invalids.email = spam_reports.email

lists_all.id = campaigns.list_ids

lists_members.email = blocks.email

lists_members.email = bounces.email

lists_members.email = contacts.email

lists_members.email = groups_members.email

lists_members.email = invalids.email

lists_members.email = segments_members.email

lists_members.email = spam_reports.email

segments_all.id = campaigns.segment_ids

segments_all.id = segments_members.segment_id

segments_members.email = blocks.email

segments_members.email = bounces.email

segments_members.email = contacts.email

segments_members.email = groups_members.email

segments_members.email = invalids.email

segments_members.email = lists_members.email

segments_members.email = spam_reports.email

segments_members.segment_id = segments_all.id

segments_members.segment_id = campaigns.segment_ids

spam_reports.email = blocks.email

spam_reports.email = bounces.email

spam_reports.email = contacts.email

spam_reports.email = groups_members.email

spam_reports.email = invalids.email

spam_reports.email = lists_members.email

spam_reports.email = segments_members.email

Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.