Apache Pulsar · AsyncAPI Specification

Apache Pulsar Messaging API

Version 3.3.0

Apache Pulsar is a cloud-native, multi-tenant, high-performance messaging and streaming platform. This spec describes the messaging patterns for producing and consuming messages on Pulsar topics with support for multiple subscription types and schema enforcement.

View Spec View on GitHub Cloud NativeMessagingMulti-TenantPub-SubStreamingApacheOpen SourceAsyncAPIWebhooksEvents

Channels

persistent/{tenant}/{namespace}/{topic}
publish produceMessage
Produce a message to a Pulsar topic
A persistent Pulsar topic. Messages are durably stored in Apache BookKeeper and available for replay. Supports partitioned and non-partitioned topics.
non-persistent/{tenant}/{namespace}/{topic}
publish produceNonPersistentMessage
Produce a message to a non-persistent topic
A non-persistent Pulsar topic. Messages are not stored to disk and are only delivered to currently connected consumers. Offers lower latency at the cost of durability.

Messages

✉
PulsarMessage
Pulsar Message
A message in Apache Pulsar

Servers

pulsar
default pulsar://localhost:6650
Default Pulsar binary protocol endpoint
ws
websocket ws://localhost:8080/ws/v2
Pulsar WebSocket API endpoint