API & Webhooks
Create workspace API keys, read your data over the REST API, and receive webhook events when something changes.
Two ways to get data out of EmailWarmer programmatically: pull it with the read-only REST API, or have it pushed to you with webhooks. The API requires a Pro plan; webhooks notify you about the events you'd otherwise learn about from in-app notifications.
API keys
API keys are scoped to your workspace and created in Settings → API Keys.
- Open Settings → API Keys and create a new key.
- Copy the key immediately.
- Store it in a secrets manager or environment variable — treat it like a password.
The full key is shown once, at creation. It cannot be retrieved afterwards. If you lose it, delete the key and create a new one.
What the API exposes
The REST API is read-only and available on the Pro plan. Conceptually, it gives you programmatic access to the same data you see in the dashboard:
- Warmup stats — per-mailbox sending activity and warmup progress
- Reputation — current reputation scores and history
- Placement results — outcomes of your placement tests, per provider
Because it's read-only, you can't start warmup, run tests, or modify mailboxes over the API — it's built for dashboards, reporting, and syncing deliverability data into your own systems, not for automation of actions.
Need write access or higher limits? That's Custom-plan territory — contact [email protected].
Webhooks
Webhooks push events to your server as they happen. Configure them in Settings → Webhooks: register an endpoint URL, and matching events arrive as JSON POST requests to that URL.
Event types
| Event | Fires when |
|---|---|
warmup.started | Warmup begins for a mailbox |
warmup.paused | Warmup is paused for a mailbox |
reputation.dropped | A mailbox's reputation score drops significantly |
blacklist.listed | Your domain or IP shows up on a monitored RBL |
reputation.dropped and blacklist.listed are the two you'll want in an alerting channel — both indicate something that degrades delivery if left alone. See how warmup works for context on the warmup lifecycle events.
Managing endpoints
- Toggle active/inactive — endpoints can be switched off without deleting them, useful during maintenance on your receiving server or while debugging.
- Delivery timestamps — each endpoint shows when events were last delivered, so you can verify at a glance that your integration is receiving traffic.
Building a receiver
Your endpoint should:
- Accept
POSTrequests with a JSON body. - Respond quickly with a
2xxstatus — do any heavy processing asynchronously after acknowledging. - Handle events idempotently, keyed on the event content, in case the same event reaches you more than once.
Start with a single endpoint receiving all four event types and log everything. Once you've seen the real payloads your account generates, wire the two alert-worthy events (reputation.dropped, blacklist.listed) into your paging or Slack channel and route the warmup lifecycle events to logs.