How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Courier

Courier Inbox Real-Time API

WebSocket service that delivers Inbox messages and message-state events (read, unread, opened, archived, clicked, mark-all-read, archive-all, archive-read) to authenticated users in real time.

Documentation Provider Profile APIs.io AsyncAPI GitHub

This event API exposes 10 operations across 10 channels, and defines 16 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through 2 servers: realtime.courier.io (wss), realtime.eu.courier.io (wss).

10 operations 10 channels 16 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Base URL
wss://realtime.courier.io
Contact
Courier
License
Proprietary
Resource Areas
1

Channels & Operations 10

Across 10 channels, the API surfaces 10 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 10
SUB
inbox/message
New inbox message delivered in real time.
onNewMessage body
SUB
inbox/read
A message was marked read.
onRead body
SUB
inbox/unread
A message was marked unread.
onUnread body
SUB
inbox/opened
A message was opened.
onOpened body
SUB
inbox/unopened
A message was marked unopened.
onUnopened body
SUB
inbox/archive
A message was archived.
onArchive body
SUB
inbox/archive-all
All messages were archived.
onArchiveAll body
SUB
inbox/archive-read
All read messages were archived.
onArchiveRead body
SUB
inbox/clicked
A message was clicked.
onClicked body
SUB
inbox/mark-all-read
All messages were marked read.
onMarkAllRead body

Messages & Schemas 16

The contract defines 16 schemas that model the data carried by its messages. The most detailed are InboxMessage (12 properties), InboxTrackingIds (6 properties), InboxAction (5 properties), InboxMessageEventEnvelope (4 properties). Each schema is shown below with its type and property counts.

NewMessageEvent
message
A new inbox message was delivered.
ReadEvent
message
A message was marked read.
UnreadEvent
message
A message was marked unread.
OpenedEvent
message
A message was opened.
UnopenedEvent
message
A message was marked unopened.
ArchiveEvent
message
A message was archived.
ArchiveAllEvent
message
All messages were archived.
ArchiveReadEvent
message
All read messages were archived.
ClickedEvent
message
A message or message action was clicked.
MarkAllReadEvent
message
All messages were marked read.
InboxMessageEvent
string
Enumeration of event types emitted on the Inbox WebSocket, as defined by the InboxMessageEvent enum in the Courier client SDKs. NewMessage is emitted over the…
InboxMessageEventEnvelope
object
Envelope wrapping each per-message event delivered by the Inbox socket. Mirrors the InboxMessageEventEnvelope type emitted to addMessageEventListener() callbac…
4 properties 1 required
InboxBulkEventEnvelope
object
Envelope for bulk events that affect more than one message, such as ArchiveAll, ArchiveRead, and MarkAllRead.
1 property 1 required
InboxMessage
object
Inbox message schema delivered over the socket. Mirrors the InboxMessage TypeScript interface exposed by @trycourier/courier-js.
12 properties 1 required
InboxAction
object
Action button rendered with an inbox message. Mirrors the InboxAction TypeScript interface.
5 properties
InboxTrackingIds
object
Tracking identifiers used to acknowledge inbox state changes.
6 properties

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

courier-asyncapi.yml Raw ↑
#Inbox#WebSocket#Real-Time#Event
← Back to C APIs
API Details
ID
courier:courier-inbox-real-time-api
Base URL
wss://realtime.courier.io
Docs
https://www.courier.com/docs/platform/inbox/inbox-overview
Provider
Courier
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=courier-courier-inbox-real-time-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/courier-courier-inbox-real-time-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Courier Inbox Real-Time API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.