Skip to main content

SendGrid

The SendGrid plugin connects Brightspot CMS content to SendGrid's Marketing Campaigns API. It lets you turn a published asset into a SendGrid Single Send email campaign without leaving the CMS tool UI—you create, target, schedule, and send the campaign, send a test email first, and track delivery and engagement stats once it goes out, all from a widget on the asset's edit screen.

Key capabilities​

  • Create a SendGrid Single Send campaign directly from a published asset, without duplicating content in SendGrid.
  • Target a campaign at SendGrid contact lists, segments, or both.
  • Schedule a campaign for a future date and time, send it immediately, or unschedule it before it goes out.
  • Update a draft campaign's content, audience, or categories before it sends.
  • Send a test email to verify content before sending to the full audience.
  • Track delivery and engagement stats (emails delivered, unique opens, open rate, unique clicks) once a campaign is sent.
  • Review a full audit trail of every SendGrid action taken on an asset.
  • Control access to each SendGrid action independently through role-based permissions.
  • Configure the integration at the Global level, with per-site overrides that inherit from Global by default.

How it works​

Any asset type can support SendGrid campaigns by implementing SendGridTemplateProvider, which supplies the campaign's subject line, preheader, and HTML and plain text content. When you create a campaign, the plugin sends that content to SendGrid's Single Send API, along with the audience lists, segments, suppression group, and categories selected in the campaign form, and stores the returned campaign ID and status locally. Subsequent actions—updating, scheduling, sending, or canceling the campaign—read and write that same SendGrid Single Send resource. The plugin also polls SendGrid for the live campaign status and, once a campaign is sent, its delivery stats, caching each response briefly so repeated views of an asset's edit screen don't exceed SendGrid's API rate limits.

Use cases​

Editorial teams sending a newsletter​

An editor finishes writing a newsletter asset, publishes it, and clicks Create Campaign in the SendGrid widget. They select a verified sender, name the campaign, and target it at a "Weekly Digest" contact list. Before sending to the full list, they send a test email to their own address to check formatting, then schedule the campaign to go out the following Tuesday at 9:00 AM.

Multi-site publishers with shared and site-specific defaults​

An organization running several sites enables SendGrid once at the Global level with a shared API key and a common set of campaign categories, so every site inherits the same configuration by default. An individual site that needs its own default subject line, or that shouldn't send campaigns at all, overrides just that setting at the Site level without duplicating the API key.

Compliance-conscious sends​

Before scheduling or sending a campaign, an editor notices a warning that the campaign is using the account's default suppression group. Rather than accept the default, they update the campaign settings to select the suppression group that matches the newsletter's actual subscription list, so unsubscribes are tracked against the correct list.

Developers integrating a new asset​

A developer wants a "Press Release" asset to support SendGrid campaigns the same way newsletters do. They implement SendGridTemplateProvider on the asset to supply its subject, preheader, and HTML/plain text content, and the existing SendGrid widget and tool pages—create, update, schedule, send, test, and view activity—work against it automatically, with no new UI to build.

Who this documentation is for​

Was this page helpful?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.