airbyte/docs/integrations/sources/sendgrid.md

Sendgrid

This page contains the setup guide and reference information for the Sendgrid source connector.

Prerequisites

• API Key

Setup guide

Step 1: Set up Sendgrid

• Sendgrid Account
• Create Sendgrid API Key with the following permissions:
  • Read-only access to all resources
  • Full access to marketing resources

Step 2: Set up the Sendgrid connector in Airbyte

For Airbyte Cloud:

1. Log into your Airbyte Cloud account.
2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
3. On the Set up the source page, enter the name for the Sendgrid connector and select Sendgrid from the Source type dropdown.
4. Enter your apikey.
5. Enter your start_time.
6. Click Set up source.

For Airbyte OSS:

1. Navigate to the Airbyte Open Source dashboard.
2. Set the name for your source.
3. Enter your apikey.
4. Enter your start_time.
5. Click Set up source.

Supported sync modes

The Sendgrid source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append

Supported Streams

• Campaigns
• Lists
• Contacts
• Stats automations
• Segments
• Single Sends
• Templates
• Global suppression (Incremental)
• Suppression groups
• Suppression group members
• Blocks (Incremental)
• Bounces (Incremental)
• Invalid emails (Incremental)
• Spam reports

Connector-specific features & highlights, if any

We recommend creating a key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access. The API key should be read-only on all resources except Marketing, where it needs Full Access. Sendgrid provides two different kinds of marketing campaigns, "legacy marketing campaigns" and "new marketing campaigns". Legacy marketing campaigns are not supported by this source connector. If you are seeing a 403 FORBIDDEN error message for https://api.sendgrid.com/v3/marketing/campaigns, it might be because your SendGrid account uses legacy marketing campaigns.

Performance considerations

The connector is restricted by normal Sendgrid requests limitation.

Changelog

Version	Date	Pull Request	Subject
0.4.0	2023-05-19	23959	Add unsubscribe_groupsstream
0.3.1	2023-01-27	21939	Fix contacts missing records; Remove Messages stream
0.3.0	2023-01-25	21587	Make sure spec works as expected in UI - make start_time parameter an ISO string instead of an integer interpreted as timestamp (breaking, update your existing connections and set the start_time parameter to ISO 8601 date time string in UTC)
0.2.16	2022-11-02	18847	Skip the stream on 400, 401 - authorization required with log message
0.2.15	2022-10-19	18182	Mark the sendgrid api key secret in the spec
0.2.14	2022-09-07	16400	Change Start Time config parameter to datetime string
0.2.13	2022-08-29	16112	Revert back to Python CDK
0.2.12	2022-08-24	15911	Bugfix to allowing reading schemas at runtime
0.2.11	2022-08-19	15800	Bugfix to allow reading sentry.yaml at runtime
0.2.10	2022-08-17	15734	Fix yaml based on the new schema validator
0.2.9	2022-08-11	15257	Migrate to config-based framework
0.2.8	2022-06-07	13571	Add Message stream
0.2.7	2021-09-08	5910	Add Single Sends Stats stream
0.2.6	2021-07-19	4839	Gracefully handle malformed responses from the API