SendGrid plugin

[richbenwell]

🔌 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

Default dashboards

A sample of two of the default dashboards:

---

🧪 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]

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]

Pull request overview

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

[Copilot]

Pull request overview

Copilot reviewed 24 out of 27 changed files in this pull request and generated 5 comments.

[Copilot]

The heading "## Overview" should be avoided according to documentation guidelines. Consider using a more specific heading like "# Before you start" or "# Prerequisites" that provides clear value to users. When embedded in SquaredUp, this documentation appears under a "Need help?" heading, so avoid redundant or generic headings.

[Copilot]

The metadata.json file is missing the 'importNotSupported' field. Since this plugin does not include an importDefinitions directory, this field should be set to true. This is a consistent pattern across all other plugins without import definitions.

[Copilot]

The label should follow the pattern of "First word uppercase, then lowercase". Consider simplifying to "Account region" to match the coding guidelines.

[Copilot]

Format the URL as a Markdown link for better readability and consistency with other plugin documentation. For example: "Create an API key at SendGrid"

[Copilot]

Dashboard names should use title case. Change "Non-delivery" to "Non-Delivery" to match the coding guidelines for dashboard naming conventions.