BSG MailHub API Docs v1.0
Dev Dashboard Prod Dashboard

BSG MailHub API Reference

Precision email delivery service. Schedule emails to arrive at an exact UTC timestamp. 1,000 emails/sec via dual-region AWS SES. Webhook callbacks for delivery events.

POST /schedule-email 1,000 emails/sec Dual-region SES Precision ±2s 10 webhook events PDF attachments
Base URL
POST
Authentication — required on every request
HeaderValueDescription
X-Api-Key bsg_<64 hex chars> Application API key — contact BSG Platform Team to obtain. Non-recoverable after issue.
X-App-Id pips · submission_engine Registered application identifier. Must match the key's registered app.
X-App-Params {"policy_id":"POL-123","batch_id":"B01"} Optional JSON metadata stored in audit trail. Visible in BSG MailHub dashboard.
System context — C4 context diagram
BSG MailHub — C4 Context Diagram C4 context diagram showing external people and systems interacting with BSG MailHub. Client apps schedule emails via the API. Recipients receive emails. App users view the AWS Admin Dashboard. BSG MailHub — C4 Context diagram System Context · External actors and system boundary only Client Apps (client side) PIPS Policy issuance & billing Submission Engine Policy submission notifications Shared BSG Apps Other client applications App users PIPS, sub engine team members PIPS Webhook Receiver HTTPS endpoint · delivery events BSG MailHub [Enterprise Application] Precision Email Scheduler Admin Dashboard CloudFront SPA · Cognito auth BSG admin Manages apps, SLA, users AWS SES Dual-region · 1,000 emails/sec Recipient mail servers MTA · SMTP delivery Audit & config store DynamoDB POST /schedule-email HTTPS · X-Api-Key reads via dashboard API sends via SESv2 SMTP writes audit Legend Azure client apps → BSG MailHub (POST /schedule-email · multipart/form-data · X-Api-Key + X-App-Id) Admin reads BSG MailHub via admin dashboard API (Cognito JWT auth) App users read BSG MailHub via Azure read-only dashboard (X-Api-Key auth) BSG MailHub → PIPS webhook (HTTPS POST · HMAC-SHA256 · DELIVERED / BOUNCED / DEFERRED / BLOCKED / OPENED events) BSG MailHub → AWS SES → recipient MTA (SMTP · dual-region · 1,000 emails/sec) Context level: External actors and system boundary only. Internal components (Lambda, Redis, DynamoDB, SNS) not shown at this level.

C4 context diagram — external actors and system boundary only. Internal components not shown at this level.

API Reference