Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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 v3 REST API and Webhooks to sync your data. 
  • Retrieves 
    • Marketing Campaigns
      • Automation
      • Single Sends
      • Senders
      • Contacts
      • Segments
      • Schedule *
    • Stats
      • Global Stats
      • Category Stats
      • Advanced Stats
    • Suppressions
      • Bounces
      • Global Unsubscribes
      • Group Unsubscribes
      • Spam Reports **
      • Blocks **


    * is present as state in the list of Automation/Single Send, but could be parsed as separate list of both entities to represent the current schedule and be a dynamic entity
    ** currently no way to test or get info about those endpoints as for that, test account should have been reported for spam and have some blocks

User Configurations

Section

User Configuration Label

Label Description

Options

Default

Variable

User Widget

StandardAPI KeyThe SendGrid API Key taken from the SendGrid account of choice

sendgrid-api-keyText Box

UsernameLogin name for Sendgrid

usernameText Box

PasswordLogin password for the username specified above

passwordText Box

Data SourceOne of the above sources picked from list

data-sourceText Box








Data Source FieldsList of fields to be retrieved

data-source-fieldsText Box
Error HandlingOn Record ErrorHow to handle error in record processing
  • Skip error
  • Send to error port
  • Fail pipeline
Skip erroron-errorRadio 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

ObjectAPI ReferenceAPI PremissionsNotes
Campaignshttps://sendgrid.api-docs.io/v3.0/lists/get-all-lists
*
Sendershttps://sendgrid.api-docs.io/v3.0/senders/create-a-sender-identity-1
v3 API allow to create sender identities, still looking for retrieving existing ones
Listshttps://sendgrid.api-docs.io/v3.0/lists/get-all-lists
*
Recipientshttps://sendgrid.api-docs.io/v3.0/contacts/get-all-contacts

Unsubscribe grouphttps://sendgrid.api-docs.io/v3.0/suppressions-unsubscribe-groups/retrieve-all-suppression-groups-associated-with-the-user

Advanced Stats https://sendgrid.com/docs/API_Reference/Web_API_v3/Stats/advanced.html

Bounceshttps://sendgrid.api-docs.io/v3.0/bounces-api/retrieve-all-bounces

Category Statshttps://sendgrid.api-docs.io/v3.0/categories/retrieve-email-statistics-for-categories

Global Statshttps://sendgrid.api-docs.io/v3.0/stats/retrieve-global-email-statistics

Marketing Campaignshttps://sendgrid.api-docs.io/v3.0/single-sends/get-all-single-sends

ScheduleTODO

Segmentshttps://sendgrid.api-docs.io/v3.0/segmenting-contacts/get-list-of-segments

Authorization

Plugin supporting Basic and API Key authorization, with using API Key by default when provided.



  • No labels