What you can build
Brand-aware AI tools
Pull your workspace’s brand context — voice, colors, fonts, and knowledge — into any AI client or external application using the Brand Context API.
Programmatic campaigns
Create, update, and manage campaigns and contact lists via the Campaign API or through the local MCP server from an AI client like Claude Desktop.
Triggered transactional email
Send event-driven emails — order confirmations, password resets, and notifications — using the Transactional Email API.
Event-driven workflows
Subscribe to campaign delivery events (sent, delivered, bounced, clicked, and more) and react to them in your own infrastructure using Webhooks.
Available API surfaces
Brand Context API
Brand Context API
The Brand Context API is a read-only endpoint that returns your workspace’s brand data — including name, description, voice guidelines, colors, fonts, social links, and knowledge base entries. Use it to give AI clients accurate, up-to-date brand context without manual copy-pasting.Endpoint:
POST https://fvtvyejucthdmnpfkrnl.supabase.co/functions/v1/brand-agentAuthenticate with a brand read key scoped to your workspace. Brand read keys expire after 90 days and cannot send mail, read contact lists, or modify campaigns.Campaign API
Campaign API
The Campaign API lets you create and manage campaigns, templates, and audiences programmatically. Campaign operations are also available through the local MCP server tools, which provide the same functionality to AI clients that support the Model Context Protocol.
Transactional Email API
Transactional Email API
The Transactional Email API lets you send triggered, one-to-one emails from your application — for example, account alerts, receipts, or onboarding sequences. Credentials and endpoints for transactional email are configured separately from marketing credentials.
Contact support@gosendwhale.com to request access to the Transactional Email API.
Webhooks
Webhooks
Webhooks push event notifications to your server when campaign delivery events occur. Subscribe to events like
campaign.sent, campaign.delivered, campaign.bounced, campaign.clicked, and campaign.unsubscribed to trigger downstream workflows in real time.Local MCP server
Local MCP server
The SendWhale MCP server runs as a local stdio server (powered by Deno) and connects AI clients — such as Claude Desktop — to your workspace via the Model Context Protocol. It exposes 11 tools, pre-built resources, and prompt templates that let an AI agent draft, review, and manage campaigns on your behalf.
Authentication modes
SendWhale supports four credential types depending on which API surface you are using.
All credentials must be passed as a
Bearer token in the Authorization header. See the Authentication page for full details on obtaining and rotating each credential type.
Workspace scope
Every API request is scoped to a single workspace. Include yourworkspace_id in the request body or as a query parameter on every call. Your data is isolated to your workspace — a credential cannot read or write data outside the workspaces it is authorized for, regardless of how the request is constructed.
Next steps
Quickstart
Make your first API request in under five minutes using the Brand Context API.
Authentication
Learn how to obtain, use, and rotate each credential type.
API Reference
Browse verified endpoints for campaigns, contacts, and brand operations.
Webhooks
Set up webhook endpoints to receive real-time delivery event notifications.
Brand Context
Read your workspace’s brand data through the Brand Context API.
MCP Server
Connect an AI client to your workspace using the local MCP server.