@brokeros/int-mail-sendgrid) connects directly to the SendGrid v3 Mail Send API.
SendGrid Email Pipeline
Required Credentials
To connect SendGrid to BrokerOS, generate an API Key in the SendGrid App Dashboard:Configuration Steps
1
Create API Key in SendGrid
Log in to
app.sendgrid.com. Navigate to Settings -> API Keys. Create an API Key with Full Access or restricted Mail Send permissions. Copy the key starting with SG..2
Authenticate Your Sending Domain
Under Settings -> Sender Authentication -> Authenticate Your Domain, choose your DNS provider (Cloudflare, GoDaddy, AWS Route 53). Add the 3 CNAME DNS records provided by SendGrid to prove domain ownership.
3
Add SendGrid in BrokerOS Settings
In the BrokerOS dashboard:
- Navigate to Dashboard -> Marketing -> Email -> Settings.
- Select the Providers & Domains tab (
/dashboard/marketing/email/settings?tab=providers). - Click Add Provider and choose SendGrid.
- Fill in the modal fields: Account Name, From Name, From Email, and API Key (
SG....). - Click Verify & Connect: BrokerOS tests credentials against
https://api.sendgrid.com/v3/user/profile, validates domain authentication, encrypts credentials via AES-256-GCM, and saves them toMarketingIntegration.
4
Configure SendGrid Event Webhook
In the SendGrid Dashboard under Settings -> Mail Settings -> Event Webhook, set the HTTP Post URL to:Enable event notifications for: Delivered, Bounced, Opened, Clicked, and Spam Reports.