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

usernameText Box

PasswordLogin password for the username specified above

passwordText Box

Data SourceOne of the above sources picked from list

data-sourceList Box








Data Source FieldsList of fields to be retrieved

data-source-fieldsText Box

Start Date(required by some SG API Endpoints)

The date in format YYYY-MM-DD, starting from which the data is requested.

not setstart-dateTODO

End Date(required by some SG API Endpoints)
The date in format YYYY-MM-DD, the end date for the requested data

not setend-dateTODO
Error HandlingOn Record ErrorHow to handle error in record processing
  • Skip error
  • Send to error port
  • Fail pipeline
Skip erroron-errorRadio Button (layout: block)

...

Field nameTypeDescription

Automation

id

name

status

type

message_count

created_at

updated_at

live_at

SingleSends

id

name

status

created_at

updated_at

is_abtest

Senders

id

nickname

address

address_2

city

country

state

zip

locked

created_at

updated_at

from_email

from_name

verified_status

verified_reason

reply_to_name

reply_to_email

Contacts

id

first_name

last_name

list_ids

created_at

updated_at

email

Segments







GlobalStats







CategoryStats

name

type

date

metrics_blocks

metrics_bounce_drops

metrics_bounces

metrics_clicks

metrics_deferred

metrics_delivered

metrics_invalid_emails

metrics_opens

metrics_processed

metrics_requests

metrics_spam_report_drops

metrics_spam_reports

metrics_unique_clicks

metrics_unique_opens

metrics_unsubscribe_drops

metrics_unsubscribes

AdvancedStats

name

type

date

metrics_clicks

metrics_opens

metrics_unique_clicks

metrics_unique_opens

Bounces

created

email

reason

status

GlobalUnsubscribes







GroupUnsubscribes

id

name

description

is_default

last_email_send_at

unsubscribes

SpamReports (TODO)







Blocks (TODO)







Schedule (TODO)







...