Sendgrid
This page contains the setup guide and reference information for the Sendgrid source connector.
Prerequisites
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
- Log into your Airbyte Cloud account or navigate to the Airbyte Open Source dashboard.
- In the left navigation bar, click Sources. In the top-right corner, click + New source.
- On the Set up the source page, enter the name for the Sendgrid connector and select Sendgrid from the Source type dropdown.
- Enter your
apikey. - Enter your
start_time. - Click Set up source.
Supported sync modes
The Sendgrid source connector supports the following sync modes:
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
- Unsubscribe Groups
Create a read-only API key (Optional)
While you can set up the Sendgrid connector using any Salesforce user with read permission, we recommend creating a dedicated read-only user for Airbyte. This allows you to granularly control the which resources Airbyte can read.
The API key should be read-only on all resources except Marketing, where it needs Full Access.
Limitations & Troubleshooting
Expand to see details about Sendgrid connector limitations and troubleshooting.
Connector limitations
Rate limiting
The connector is restricted by normal Sendgrid requests limitation.
Troubleshooting
- Legacy marketing campaigns are not supported by this source connector. Sendgrid provides two different kinds of marketing campaigns, "legacy marketing campaigns" and "new marketing campaigns". 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. - Check out common troubleshooting issues for the Sendgrid source connector on our Airbyte Forum.
Reference
Config fields reference
Field
Type
Property name
string
apikey
string
start_time
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.5.0 | 2024-03-26 | 36455 | Unpin CDK version, add record counts to state messages |
| 0.4.3 | 2024-02-21 | 35181 | Handle uncompressed contacts downloads |
| 0.4.2 | 2024-02-12 | 35181 | Manage dependencies with Poetry |
| 0.4.1 | 2023-10-18 | 31543 | Base image migration: remove Dockerfile and use the python-connector-base image |
| 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 |