# Forward Email WebSockets API

**Canonical:** https://apis.io/apis/forward-email/forward-email-websockets-api/  
**Provider:** Forward Email — https://apis.io/providers/forward-email/  
**Base URL:** https://api.forwardemail.net  
**Documentation:** https://forwardemail.net/

Forward Email WebSockets API is one of 16 APIs that [Forward Email](https://apis.io/providers/forward-email/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include WebSockets. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Real-time push notifications via WebSocket. Connect to the /v1/ws endpoint to receive live events. Authentication is optional: authenticated clients receive per-alias events (IMAP, CalDAV, CardDAV) and global broadcast events, while unauthenticated clients receive only global broadcast events (e.g. newRelease). Supports 20 distinct event types covering message delivery, moves, copies, flag changes, expunges, mailbox CRUD, calendar CRUD, calendar event CRUD, contact CRUD, address book CRUD, and app release broadcasts from the Forward Email Mail App (https://github.com/forwardemail/mail.forwardemail.net).

## Operations (1)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/ws` | WebSocket Notifications |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/forward-email/openapi/forward-email-websockets-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-domain-schema.json
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-update-domain-input-schema.json
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-message-schema.json
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-smtp-schema.json
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-alias-account-schema.json
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-alias-input-schema.json

## Other Forward Email APIs (12)

- [Forward Email Account API](https://apis.io/apis/forward-email/forward-email-account-api/)
- [Forward Email Aliases API](https://apis.io/apis/forward-email/forward-email-aliases-api/)
- [Forward Email Calendar Events API](https://apis.io/apis/forward-email/forward-email-calendar-events-api/)
- [Forward Email Calendars API](https://apis.io/apis/forward-email/forward-email-calendars-api/)
- [Forward Email Contacts API](https://apis.io/apis/forward-email/forward-email-contacts-api/)
- [Forward Email Domains API](https://apis.io/apis/forward-email/forward-email-domains-api/)
- [Forward Email Emails API](https://apis.io/apis/forward-email/forward-email-emails-api/)
- [Forward Email Encrypt API](https://apis.io/apis/forward-email/forward-email-encrypt-api/)
- [Forward Email Folders API](https://apis.io/apis/forward-email/forward-email-folders-api/)
- [Forward Email Invites API](https://apis.io/apis/forward-email/forward-email-invites-api/)
- [Forward Email Logs API](https://apis.io/apis/forward-email/forward-email-logs-api/)
- [Forward Email Members API](https://apis.io/apis/forward-email/forward-email-members-api/)

## Tags

WebSockets

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/forward-email/forward-email-websockets-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/forward-email/.
