Skip to content

SendGrid plugin#22

Open
richbenwell wants to merge 5 commits intomainfrom
work/rb/sendgrid
Open

SendGrid plugin#22
richbenwell wants to merge 5 commits intomainfrom
work/rb/sendgrid

Conversation

@richbenwell
Copy link
Contributor

@richbenwell richbenwell commented Feb 4, 2026

🔌 Plugin overview

A plugin for Twilio SendGrid, a popular SMTP server.

The plugin provides data streams for email send stats and unsubscribes, allowing software and marketing teams to report on email performance.

Authentication is via API key.

API permissions required:

  • Stats (read-only)
  • Suppressions (read-only)

🖼️ Plugin screenshots

Plugin configuration

Screenshot 2026-02-04 at 4 33 51 pm

Default dashboards

A sample of two of the default dashboards:
Screenshot 2026-02-04 at 4 32 43 pm
Screenshot 2026-02-04 at 4 32 17 pm


🧪 Testing

Tested all data streams against a live production SendGrid account.


⚠️ Known limitations

Account credits cannot be monitored using this plugin. An API endpoint is available, but seems to require an API key with full admin access.


📚 Checklist

  • Plugin, datastream and UI naming follow SquaredUp guidelines
  • Logo added
  • One or more dashboards added
  • README added including configuration guidance
  • No secrets or credentials included
  • I agree to the Code of Conduct

Copilot AI review requested due to automatic review settings February 4, 2026 21:40
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request introduces a new community plugin for Twilio SendGrid, a popular SMTP email service. The plugin enables users to monitor email performance metrics including delivery statistics, engagement data, unsubscribes, bounces, blocks, and invalid emails through API key authentication.

Changes:

  • Added SendGrid v1 plugin with 12 data streams for email statistics and suppression lists
  • Created 4 default dashboards (Engagement, Non-delivery, Unsubscribes, Email Client Insights)
  • Configured UI for API key authentication and region selection (Global/EU)

Reviewed changes

Copilot reviewed 23 out of 24 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
plugins/SendGrid/v1/metadata.json Plugin metadata including display name, version, author, and base API configuration
plugins/SendGrid/v1/ui.json User interface configuration for API key and region selection
plugins/SendGrid/v1/icon.png Plugin icon in PNG format
plugins/SendGrid/v1/dataStreams/*.json 12 data stream definitions for stats, bounces, blocks, unsubscribes, spam reports, and client insights
plugins/SendGrid/v1/dataStreams/scripts/script1-post.js Post-processing script for flattening stat arrays
plugins/SendGrid/v1/defaultContent/*.json Manifest files and folder structure for default content
plugins/SendGrid/v1/defaultContent/SendGrid/*.dash.json 4 dashboard definitions for visualizing email metrics

Copilot AI review requested due to automatic review settings February 4, 2026 22:03
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 23 out of 26 changed files in this pull request and generated 12 comments.

@clarkd clarkd added the new-plugin Used to PR newly added plugins label Feb 5, 2026
"pattern": ".*"
}
],
"timeframes": true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because you're only passing in the date part of the timeframe start/end, it might be worth restricting the timeframes here to exclude last 1 hour and last 12 hours? e.g.

Suggested change
"timeframes": true
"timeframes": [
"last24hours",
"last7days",
"last30days",
"thisMonth",
"thisQuarter",
"thisYear",
"lastMonth",
"lastQuarter"
]

@clarkd clarkd self-assigned this Feb 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new-plugin Used to PR newly added plugins

Development

Successfully merging this pull request may close these issues.

2 participants