SendGrid

Send transactional emails and manage contacts via SendGrid.

MarketingAPI key3 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (3)
send_email
custom_api_call
send_dynamic_template
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("sendgrid", "send_email", {
    "to": [],
    "from": "<from (email)>",
    "subject": "<subject>",
    "content_type": "<content_type>",
    "content": "<content>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("SendGrid answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "sendgrid-send-email",
  name: "SendGrid: Send Email",
  description: "Calls SendGrid when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("sendgrid", {
      "action": "send_email",
      "to": [],
      "from": "<from (email)>",
      "subject": "<subject>",
      "content_type": "<content_type>",
      "content": "<content>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/sendgrid/send_email" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"to":[],"from":"<from (email)>","subject":"<subject>","content_type":"<content_type>","content":"<content>"}}'

Actions

send_emailin catalog

Send Email. Send a text or HTML email

Input	Type	Description
`to`required	array	Emails of the recipients
`from`required	text	Sender email, must be on your SendGrid
`from_name`optional	text	Sender name
`reply_to`optional	text	Email to receive replies on (defaults to sender)
`subject`required	text	Subject
`content_type`required	id (picked from your account)	Content Type
`content`required	text	HTML is only allowed if you selected HTML as type
`attachments`optional	array	Attachments

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

send_dynamic_template

Send Dynamic Template. Send an email using a dynamic template

Input	Type	Description
`to`required	array	Emails of the recipients
`from_name`optional	text	Sender name
`from`required	text	Sender email, must be on your SendGrid
`template_id`required	text	Dynamic template id
`template_data`required	JSON	Dynamic template data
`reply_to`optional	text	Email to receive replies on (defaults to sender)
`attachments`optional	array	Attachments

Details

Id: sendgrid
Category: Marketing
Tags: email, transactional, marketing, contacts
Package: @activepieces/piece-sendgrid@0.5.1
Tier: Community