The SendGrid is a communication platform for transactional and marketing emails.
...
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 | |||
| Start Date | (required by some SG API Endpoints) The date in format YYYY-MM-DD, starting from which the data is requested. | not set | start-date | TODO | ||
| End Date | (required by some SG API Endpoints) The date in format YYYY-MM-DD, the end date for the requested data | not set | end-date | TODO | ||
| Error Handling | On Record Error | How to handle error in record processing |
| Skip error | on-error | Radio Button (layout: block) |
...
Design Tips and references
SendGrid v3 API:
- https://sendgrid.api-docs.io/v3.0/
- https://sendgrid.com/docs/API_Reference/Web_APIapi_v3/index.html
SendGrid supports API v2 and v3 with Legacy Marketing Campaigns (LMC) API and New Marketing Campaigns(NMC) legacy and and SendGrid v3 API . As v2 and LMC API v3 legacy are outdated, plugin we going to support and use API v3 and NMC API. The old accounts, which still using LMC may need to migrate to the NMC.
...
the latest SendGrid v3 API.
Data source reference
| Object | API Reference | API Premissions | Notes | Campaigns||||
|---|---|---|---|---|---|---|---|
| Automations | - | No documentation available, but the usage could be revers engineered through debugging of official UI | |||||
| Single Sends | https://sendgrid.api-docs.io/v3.0/listssingle-sends/get-all-lists | * | Senders-single-sends | ||||
| Senders | - | No documentation available, but the usage could be revers engineered through debugging of official UI | |||||
| Contacts | https://sendgrid.api-docs.io/v3.0/senderscontacts/createget-a-sender-identity-1 | v3 API allow to create sender identities, still looking for retrieving existing ones | Listsall-contacts | ||||
| Segments | https://sendgrid.api-docs.io/v3.0/listssegmenting-contacts/get-list-allof-listssegments | * | |||||
| RecipientsGlobalStats | https://sendgrid.api-docs.io/v3.0/contactsstats/getretrieve-global-allemail-contactsstatistics | ||||||
| Unsubscribe groupCategoryStats | https://sendgrid.api-docs.io/v3.0/suppressions-unsubscribe-groupscategories/retrieve-allemail-suppressionstatistics-groups-associated-with-the-user | Advanced Stats | for-categories | ||||
| AdvancedStats | https://sendgrid.com/docs/API_Reference/Web_API_v3/Stats/advanced.html | ||||||
| Bounces | https://sendgrid.api-docs.io/v3.0/bounces-api/retrieve-all-bouncesCategory Stats | ||||||
| Global Unsubscribes | - | No documentation available, but the usage could be revers engineered through debugging of official UI | |||||
| Group Unsubscribes | https://sendgrid.api-docs.io/v3.0/categoriessuppressions-unsubscribe-groups/retrieve-email-statistics-for-categoriesGlobal Statsall-suppression-groups-associated-with-the-user | ||||||
| Spam Reports | https://sendgrid.api-docs.io/v3.0/statsspam-reports-api/retrieve-globalall-emailspam-statisticsreports | ||||||
| Marketing CampaignsBlocks | https://sendgrid.api-docs.io/v3.0/singleblocks-sendsapi/getretrieve-all-single-sends | Schedule | TODO | Segments | https://sendgrid.api-docs.io/v3.0/segmenting-contacts/get-list-of-segmentsblocks | ||
| Schedule | - |
Data sources description
| Field name | Type | Description |
|---|---|---|
Automation | ||
Single Sends | ||
Senders | ||
Contacts | ||
Segments | ||
Global Stats | ||
Category Stats | ||
Advanced Stats | ||
Bounces | ||
Global Unsubscribes | ||
Group Unsubscribes | ||
Spam Reports (TODO) | ||
Blocks (TODO) | ||
Schedule (TODO) | ||
Authorization
Plugin supporting Basic and API Key authorization, with using API Key by default when provided.
...