Skip to main content
Version: 1.0.x

Configuring the SendGrid integration

SendGrid settings live on the Site Settings screen, at both the Global level and the individual Site level. A site inherits every setting from Global by default; overriding a setting at the Site level replaces the inherited value for that site only. Access to individual SendGrid actions—creating a campaign, sending it, viewing its activity log, and so on—is controlled separately through a SendGrid additional permission on each role.

Enabling SendGrid and adding an API key

To configure SendGrid at the Global level:

  1. From the left navigation, under Admin, click Sites & Settings, then select the Global site.
  2. From the Integrations tab, expand the SendGrid cluster.

  3. Toggle on the Enabled setting.

  4. Expand API Settings, and type your SendGrid account's API key.

  5. Using the following table as a reference, complete the fields as needed:

    FieldDescription
    Default SubjectThe subject line used for a new campaign when the asset doesn't supply its own subject.
    Default PreheaderThe preheader text used for a new campaign when the asset doesn't supply its own preheader.
    SendGrid CategoriesThe pool of categories editors can select from when creating a campaign.
  6. Click Save.

To override settings for an individual site:

  1. From the left navigation, under Admin, click Sites & Settings.
  2. From the Integrations tab, expand the SendGrid cluster.
  3. Toggle on the Enabled setting, or leave it blank to inherit the Global value.
  4. (Optional) Expand API Settings, and type a site-specific API key. Leave it blank to fall back to the Global API key.
  5. Using the table above as a reference, override any defaults as needed. Fields left blank inherit the corresponding Global value.
  6. Click Save.
note

Enabling SendGrid requires an API key—either entered directly in API Settings or inherited from the Global level. Brightspot blocks saving Site Settings with Enabled set to Yes and no API key available from either source.

Setting up permissions

Each SendGrid action—creating, updating, scheduling, sending, and so on—has its own permission. Grant access to these actions by adding the SendGrid additional permission to a role.

To control which SendGrid actions a role can perform:

  1. Open the role you want to configure.

  2. Add the SendGrid additional permission.

  3. From the Permissions list, select All, Only, or All Except.

  4. If you selected Only or All Except, select the specific actions to grant or exclude from the list of actions that appears. Using the following table as a reference, choose from the available actions:

    ActionWhat it allows
    Create Single Send CampaignCreate a new campaign from an asset.
    Update CampaignUpdate a draft campaign's content, audience, or categories.
    Schedule CampaignSchedule a draft campaign for a future date and time.
    Send Campaign NowSend a draft campaign immediately.
    Send Test EmailSend a test email for a campaign.
    Unschedule CampaignCancel a scheduled campaign and return it to draft.
    Disconnect from CampaignRemove the local association between an asset and its SendGrid campaign, without deleting the campaign in SendGrid.
    View Activity LogView the audit trail of SendGrid actions taken on an asset.
    Campaign SettingsView a campaign's settings in read-only form.
  5. Click Save.

tip

Grant All to roles that manage the full campaign lifecycle. Use Only or All Except to restrict less-trusted roles—for example, to a role that can only view the activity log.