Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The SendGrid is a communication platform for transactional and marketing emails.

...

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

username

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)



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