Versions Compared

Old Version 4

changes.mady.by.user Dmytro Grinenko

Saved on

compared with

New Version 5

changes.mady.by.user Dmytro Grinenko

Saved on

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

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)

...

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.