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

Commune Event delivery API

Where a newsletter's events go, and how a creator changes it. Communehands every event it publishes to a delivery service that owns fan out,retries, signing and the delivery log, and a destination is one place thatservice sends them: an HTTPS endpoint, or a queue, stream or object storefor a consumer that would rather not run a web server.Reading the list is an operation here, and so is reading the deliveryattempt log: what was handed to which destination, what came back, andasking for one to be handed over again.Changing the destinations themselves is not. `portal-session` mints a linkinto the delivery service's own portal, where a creator adds an endpoint,disables one and rotates a signing secret. Asking for an attempt to bereplayed is the one write here, and is the same action as the portal'sretry button.Needs `webhooks` throughout, since a destination is a private endpoint ofthe creator's, the list of them says which systems a newsletter is wiredinto, and the attempt log says what those systems were told and when.

Commune Event delivery API is one of 18 APIs that Commune publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Event Delivery. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 2026-08-26.

Requests are made against a single base URL, https://api.usecommune.com.

5 operations 5 paths 20 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-08-26
Base URL
https://api.usecommune.com
Authentication
OAuth 2.0, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Commune Event delivery API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 13 scopes. It accepts HTTP bearer tokens (Commune API key) (apiKey). By default, every request must be authenticated.

  • oauth2 — An OAuth access token, sent as Authorization: Bearer . The walkthrough of the whole flow is at [usecommune.dev/use-cases/build-an-integration](https://usecommu…
  • apiKey — A Commune API key, sent as Authorization: Bearer . A key is granted one or more newsletters and carries six permission families on each, every one of them none…

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Event delivery 5

Where a newsletter's events go, and how a creator changes it.

GET
/newsletters/{newsletter}/destinations
List where a newsletter's events go
listNewsletterDestinations 6 params → 200400401403404429500503
GET
/newsletters/{newsletter}/delivery-attempts
List what was delivered where, and how it went
listNewsletterDeliveryAttempts 9 params → 200400401403404429500503
GET
/delivery-attempts/{attempt}
Retrieve one delivery attempt
getDeliveryAttempt 5 params → 200400401403404429500503
POST
/delivery-attempts/{attempt}/replay
Send an event to a destination again
replayDeliveryAttempt 4 params → 202400401402403404409422
POST
/newsletters/{newsletter}/portal-session
Open the event delivery portal
createPortalSession 2 params → 200400401403404429500503

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Article (18 properties), Newsletter (16 properties), Thread (16 properties), DeliveryAttempt (13 properties). Each schema is shown below with its type and property counts.

ArticleStatus
string
Where an article is in its life. A credential holding only read permissions ever sees sent and nothing else. An imported article is always sent, since Commune…
Pagination
object
Cursor pagination state. Commune never exposes an offset or a page number: a collection is a moving window, and an offset silently skips or repeats items when…
2 properties 2 required
SocialLinks
object
The creator's other homes on the internet, stored as canonical profile URLs. Every key is optional and a newsletter that set none returns an empty object.
8 properties
ArticleStats
object
Engagement counts for an article, computed at read time. These are Commune side counts, not provider side email metrics: opens, clicks and deliveries are not h…
3 properties 3 required
User
object
A person's public profile, and the whole of what this API returns about anybody other than the credential's own owner. Email address, theme, notification prefe…
5 properties 2 required
Ref
object
An unexpanded relationship. Ask for the relationship in ?expand= to get the full object in its place.
2 properties 2 required
Media
object
An image or file attached to a thread or a message.
3 properties 1 required
Thread
object
A conversation in a newsletter's community, together with the message that opened it. Its replies are a separate collection.
16 properties 8 required
Error
object
The error envelope. Every non 2xx response from every operation has this shape, so a client can branch on error.code without knowing which operation produced i…
1 property 1 required
Esp
string
Where a newsletter is published from. commune means Commune itself sends the email. Every other value is an email service provider whose posts Commune imports.…
DeliveryAttempt
object
One handover of one event to one destination, and what came of it. A record of something that happened rather than a thing with a state: it never changes after…
13 properties 12 required
Destination
object
One place a newsletter's published events are delivered to. Nothing a destination authenticates with is on this shape, and neither is its full configuration, w…
10 properties 7 required
Newsletter
object
A newsletter and its public profile. Nothing operational is exposed: ESP credentials, OAuth tokens, group and audience ids, feed polling state and language det…
16 properties 6 required
Article
object
One article of a newsletter, without its body. Every collection of articles returns this shape. GET /articles/{article} returns ArticleWithContent, which is th…
18 properties 8 required
ThreadVisibility
string
Where a thread is placed. public puts it on the global Commune feed and makes it readable by anyone. subscribers keeps it inside the newsletter. paid narrows i…
ListEnvelope
object
The envelope every collection is returned in. data holds the page, pagination holds the cursor state. data is required here and typed by each list operation, a…
2 properties 3 required
DeliveryAttemptStatus
string
How one attempt ended. succeeded is a 2xx from the destination. failed is anything else, including no answer at all, and is not final: the delivery service ret…
DeliveryReplay
object
The acknowledgement that a replay was accepted. Not an attempt: the attempt this produces does not exist yet when the response is written. What it carries is e…
4 properties 4 required
ErrorCode
string
The stable, machine readable reason a request failed. New codes may be added in a minor version, so treat an unrecognised code as a generic failure of its HTTP…
PortalSession
object
A link into the delivery portal, and the moment it stops working. Not a resource: it has no identifier, nothing addresses it, and it cannot be fetched again. I…
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

usecommune-event-delivery-api-openapi.yml Raw ↑

Other APIs Commune publishes across the network.

Commune Articles API
Commune Engagement API
Commune Highlights API
Commune Messages API
Commune Metrics API
Commune Newsletters API
Commune Platform API
Commune Search API
Commune Senders API
Commune Sends API
Commune Subscriber tags API
Commune Subscribers API
Where this information came from

This is an independent, third-party profile of Commune Event delivery 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.