Zulip Events API
The Zulip Events API delivers real-time updates from a Zulip server to a client via an HTTPS long-poll. Clients register an event queue via POST /api/v1/register, then call GET /api/v1/events with the returned queue_id and last_event_id to receive batches of typed events covering messages, reactions, subscriptions, presence, typing, channel/stream changes, user and organization updates, custom emoji, alert words, message-flag changes, drafts, scheduled messages, reminders, user groups, and system heartbeat/restart signals.
Zulip Events API is one of 17 APIs that Zulip publishes on the APIs.io network, described by an AsyncAPI event-driven specification.
Tagged areas include Events, Long Polling, Real Time, and Team Chat. The published artifact set on APIs.io includes API documentation, an API reference, and an AsyncAPI specification.
This event API exposes 2 operations across 2 channels, and defines 52 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.
The API connects through 2 servers: https://{subdomain}.zulipchat.com/api/v1 (https), https://{host}/api/v1 (https).
Metadata
The identity and technical contract details declared by the specification.
Channels & Operations 2
Across 2 channels, the API surfaces 2 operations. Each is listed below with its action, channel, parameters, and response codes.
Messages & Schemas 52
The contract defines 52 schemas that model the data carried by its messages. The most detailed are RegisterResponse (5 properties), EventBase (2 properties), EventBatch (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable AsyncAPI contract behind this narrative.
Source
More from Zulip 12
Other APIs Zulip publishes across the network.