Skip to content
Proud to collaborate with Microsoft for Startups

sendgrid.email.send ​

Send a transactional email via SendGrid

Send a transactional email via the SendGrid Mail Send API v3.

Inputs:

  • from_address: Verified sender address (required).
  • from_name: Sender display name (optional).
  • to_addresses: List of recipient email addresses (required).
  • subject: Email subject line (required).
  • html_content: HTML email body (optional but recommended).
  • text_content: Plain-text email body (optional).

Outputs (terminal state_data):

  • message_id: str | None — SendGrid X-Message-Id header value

Plugin required: context.get_plugin("sendgrid") must expose .api_key.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-sendgrid
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
from_addressstringYes—Verified sender address
from_namestringNo—Sender display name
to_addressesjsonYes—List of recipient email addresses
subjectstringYes—Email subject
html_contentstringNo—HTML body
text_contentstringNo—Plain-text body

Output Schema ​

FieldTypeRequiredDefaultDescription
from_addressstringNo——
from_namestringNo——
to_addressesjsonNo——
subjectstringNo——
html_contentstringNo——
text_contentstringNo——
message_idstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "sendgrid.email.send",
  "initial_data": {
    "from_address": "value",
    "to_addresses": "value",
    "subject": "value"
  }
}