61af7a45e4
* add .yaml to list of file imports in setup.py * bump dockerfile version for sentry * update sentry changelog * correct sentry, greenhouse, and sendgrid sources to correctly read configs * add changelog * update Dockerfile versions * auto-bump connector version [ci skip] * auto-bump connector version [ci skip] * fix greenhouse SAT tests and update to next version of cdk w/ schema read fix * auto-bump connector version [ci skip] Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
3.9 KiB
Sendgrid
This page contains the setup guide and reference information for the Sendgrid source connector.
Prerequisites
Note: 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.
Generate an API key using the Sendgrid documentation.
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.
To consume Messages resources requires to purchase an extra on Sendgrid. You can read more about this here
Setup guide
Step 1: Set up Sendgrid
- Sendgrid Account
- 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:
- Log into your Airbyte Cloud account.
- 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.
For Airbyte OSS:
- Navigate to the Airbyte Open Source dashboard.
- Set the name for your source.
- Enter your
apikey. - Enter your
start_time. - Click Set up source.
Supported sync modes
The Sendgrid source connector supports the following sync modes:
| Feature | Supported? |
|---|---|
| Full Refresh Sync | Yes |
| Incremental Sync | Coming soon |
| Replicate Incremental Deletes | Coming soon |
| SSL connection | Yes |
| Namespaces | No |
Supported Streams
- Campaigns
- Lists
- Contacts
- Stats automations
- Segments
- Single_sends
- Templates
- Global suppression
- Suppression groups
- Suppression group members
- Blocks
- Bounces
- Invalid emails
- Spam reports
- Messages
Performance considerations
The connector is restricted by normal Sendgrid requests limitation.
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 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 |