The SendGrid is a communication platform for transactional and marketing emails.
User Expectations
- User will retrieve API Keys (Restricted Access) from their SendGrid account for Event Notification, Marketing Campaigns, Suppressions and Tracking.
- User will enable Active Tracking in their account - Click, Open and Subscription tracking is enabled.
- Uses SendGrid REST APIs and Webhooks to sync your data.
- Retrieves
- Campaigns,
- Senders,
- Lists,
- Recipients,
- Unsubscribe groups,
- Advanced Stats,
- Bounces,
- Category Stats,
- Global Stats,
- Lists,
- Marketing Campaigns,
- Schedule,
- Segments,
User Configurations
Section | User Configuration Label | Label Description | Options | Default | Variable | User Widget |
|---|---|---|---|---|---|---|
| Standard | API Key | The SendGrid API Key taken from the SendGrid account of choice | sendgrid-api-key | Text Box | ||
| Username | Login name for Sendgrid | username | Text Box | |||
| Password | Login password for the username specified above | password | Text Box | |||
| Data Source | One of the above sources picked from list | data-source | Text Box | |||
| Data Source Fields | List of fields to be retrieved | data-source-fields | Text Box | |||
| Error Handling | On Record Error | How to handle error in record processing |
| Skip error | on-error | Radio Button (layout: block) |
Plugin Type
- Batch Source
- Batch Sink
- Real-time Source
- Real-time Sink
- Action
- Post-Run Action
- Aggregate
- Join
- Spark Model
- Spark Compute
Design Tips and references
SendGrid API:
- https://sendgrid.api-docs.io/v3.0/
- https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html
SendGrid supports API v2 and v3 with Legacy Marketing Campaigns (LMC) API and New Marketing Campaigns(NMC) API. As v2 and LMC API are outdated, plugin going to use API v3 and NMC API. The old accounts, which still using LMC may need to migrate to the NMC.
Objects reference
Authorization
Plugin supporting Basic and API Key authorization, with using API Key by default when provided.