API Documentation & Integrations

Complete REST API documentation for WarmySender. Build custom integrations with our email warmup, campaign, and LinkedIn automation APIs.

Authentication

All API requests require a Bearer token in the Authorization header. Generate API keys from Settings > API Keys in your WarmySender dashboard. Keys are scoped to your workspace and support granular permissions.

Authorization: Bearer your-api-key-here

Base URL

All API endpoints are available at:

https://warmysender.com/api/v1

Rate Limiting

API requests are limited to 60 requests per minute per workspace. Rate limit headers are included in all responses:

• X-RateLimit-Limit — Maximum requests per window
• X-RateLimit-Remaining — Remaining requests in current window
• X-RateLimit-Reset — Unix timestamp when the window resets
• Retry-After — Seconds to wait (only on 429 responses)

API Endpoints

Prospects

• GET /api/v1/prospects — List prospects with pagination and filters (returns email, firstName, lastName, company, role, phone, linkedinUrl, customFields, globalStatus)
• POST /api/v1/prospects — Create a new prospect
• PUT /api/v1/prospects/:id — Update a prospect
• DELETE /api/v1/prospects/:id — Delete a prospect

Campaigns

• GET /api/v1/campaigns — List all campaigns
• POST /api/v1/campaigns — Create a new campaign
• POST /api/v1/campaigns/:id/enrollments — Enroll prospects in a campaign
• DELETE /api/v1/campaigns/:id/enrollments — Unenroll prospects (soft-delete)
• PATCH /api/v1/campaigns/:id — Update campaign settings

Mailboxes

• GET /api/v1/mailboxes — List connected mailboxes
• GET /api/v1/mailboxes/:id/stats — Get mailbox health stats

Warmup

• GET /api/v1/warmup/status — Get warmup status for all mailboxes
• POST /api/v1/warmup/toggle — Enable or disable warmup

Suppressions

• GET /api/v1/suppressions — List suppressed emails
• POST /api/v1/suppressions — Add emails to suppression list

Webhooks

WarmySender sends real-time webhook notifications for key events. Configure webhooks from Settings → Webhooks or via the API. Each delivery is signed with HMAC-SHA256 (X-Warmy-Signature) and retried up to 10 times with exponential backoff (1 min → 72 h) until your endpoint returns a 2xx.

Event types

• reply.received — Prospect replied to a campaign email
• email.bounced — Email hard-bounced (permanent delivery failure)
• email.unsubscribed — Prospect clicked the unsubscribe link
• email.opened — Prospect opened a campaign email (first open per campaign)
• email.clicked — Prospect clicked a tracked link in a campaign email
• prospect.suppressed — Prospect added to the suppression list
• limit.hit — A daily sending limit was reached (mailbox, domain, or plan)
• linkedin.reply_received — Prospect replied to a LinkedIn message or InMail (payload includes the reply body, prospect profile URL, campaign and enrollment IDs)
• linkedin.invite_accepted — Prospect accepted a LinkedIn connection request
• webhook.test — Test event fired via the Settings UI or API for endpoint verification

Native Slack integration (no middleware)

Paste a Slack Incoming Webhook URL (https://hooks.slack.com/services/…) into Settings → Webhooks and we auto-format each event as a Block Kit message. LinkedIn reply notifications include the reply body, prospect name, profile URL, and campaign — rendered as a readable Slack card. No Zapier, Make, or n8n required in the middle. Rate limits are honored automatically via the Retry-After header on HTTP 429.

n8n, Zapier, Make integration

Create an HTTP Trigger (Webhook) node in n8n (or a Webhook trigger in Zapier / Make), copy its Production URL, and paste it into Settings → Webhooks. You receive the full JSON payload and can fan out to any downstream system — Slack, Discord, Teams, HubSpot, Pipedrive, Airtable, Google Sheets, Notion, or a custom database — with conditional logic and transformations between steps. Signature verification via X-Warmy-Signature is recommended when your endpoint is publicly reachable.

Popular Integrations

• HubSpot — Sync prospects and campaign activity
• Salesforce — Push leads and track outreach
• Zapier — Connect to 5,000+ apps
• Make (Integromat) — Advanced workflow automation
• Slack — Real-time campaign and LinkedIn reply notifications
• n8n — Self-hosted workflow automation

Full Documentation | Pricing