Zulip real_time_events API
The real_time_events API from Zulip — 4 operation(s) for real_time_events.
Zulip real_time_events API is one of 17 APIs that Zulip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include real_time_events. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 5 operations across 4 paths, and defines 72 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.
Requests are made against 5 base URLs: https://{subdomain}.zulipchat.com/api/v1, {server}/api/v1, https://chat.zulip.org/api/v1, http://localhost:9991/api/v1, http://{subdomain}.testserver/json.
5 operations
4 paths
72 schemas
1 DELETE1 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zulip real_time_events API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
BasicAuth— Basic authentication, with the user's email as the username, and the API key as the password. The API key can be fetched using the /fetchapikey or /devfetchapi…
Paths & Operations 5
Across 4 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
real_time_events 5
GET
/events
Get events from an event queue
DELETE
/events
Delete an event queue
POST
/register
Register an event queue
POST
/real-time
(Ignored)
POST
/rest-error-handling
Error handling
Schemas 72
The contract defines 72 schemas that model the data the API accepts and returns. The most detailed are Subscription (41 properties), BasicChannelBase (29 properties), MessagesBase (22 properties), UserBase (18 properties). Each schema is shown below with its type and property counts.
Narrow
array
A JSON-encoded array of arrays of length 2 indicating the [narrow filter(s)](/api/construct-narrow) for which you'd like to receive events for. For example, to…
BasicChannel
WebhookConfigOption
array
An array of configuration options that can be set when creating a bot user for this incoming webhook integration. This is an unstable API. Please discuss in ch…
IncompatibleParametersError
MissingArgumentError
MessagesBase
object
Object containing details of the message.
22 properties
EmojiReactionEvent
IgnoredParametersUnsupported
array
An array of any parameters sent in the request that are not supported by the endpoint. See [error handling](/api/rest-error-handlingignored-parameters) documen…
RealmAuthenticationMethod
object
Dictionary describing the properties of an authentication method for the organization - its enabled status and availability for use by the organization.
3 properties
RealmDeactivatedError
ChannelCanAddSubscribersGroup
Draft
object
A dictionary for representing a message draft.
6 properties
4 required
CodedError
InvalidApiKeyError
AllPublicChannels
boolean
Whether you would like to request message events from all public channels. Useful for workflow bots that you'd like to see all new messages sent to public chan…
BadEventQueueIdError
DefaultChannelGroup
object
Dictionary containing details of a default channel group.
4 properties
FolderId
integer
The ID of the folder to which the channel belongs. Is null if channel does not belong to any folder. Changes: New in Zulip 11.0 (feature level 389).
UserStatus
object
5 properties
CanCreateTopicGroup
RealmExport
object
Object containing details about a [data export](/help/export-your-organization).
8 properties
SavedSnippet
object
Object containing the details of the saved snippet.
4 properties
JsonSuccess
Attachment
object
Dictionary containing details of a file uploaded by a user.
6 properties
CanMoveMessagesWithinChannelGroup
BasicBot
TopicsPolicy
string
Whether [named topics](/help/introduction-to-topics) and the empty topic (i.e., ["general chat" topic](/help/general-chat-topic)) are enabled in this channel.…
CanSubscribeGroup
CanMoveMessagesOutOfChannelGroup
UserDeactivatedError
NavigationView
object
Represents a user's personal configuration for a specific navigation view (displayed most visibly at the top of the web application's left sidebar). Navigation…
3 properties
2 required
CustomProfileField
object
Dictionary containing the details of a custom profile field configured for this organization.
10 properties
7 required
CanSendMessageGroup
RealmPlayground
object
Object containing details about a realm playground.
4 properties
EventTypeSchema
string
The event's type, relevant both for client-side dispatch and server-side filtering by event type in [POST /register](/api/register-queue).
JsonSuccessBase
Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include…
EventIdSchema
integer
The ID of the event. Events appear in increasing order but may not be consecutive.
RateLimitedError
BasicBotBase
object
5 properties
WebhookUrlOption
array
An array of optional URL parameter options for the incoming webhook integration. In the web app, these are used when [generating a URL for an integration](/hel…
EmojiBase
object
3 properties
CanRemoveSubscribersGroup
ScheduledMessageBase
object
Object containing details of the scheduled message.
8 properties
7 required
JsonResponseBase
object
1 property
RealmDomain
object
2 properties
2 required
ScheduledMessage
CanDeleteAnyMessageGroup
MessagesEvent
Bot
User
UserNotAuthorizedError
ChannelFolder
object
Object containing the channel folder's attributes.
8 properties
RealmEmoji
object
Object containing details about an emoji. It has the following properties:
6 properties
CanDeleteOwnMessageGroup
CodedErrorBase
GroupSettingValue
EmailAddressVisibility
integer
The [policy][permission-level] for [which other users][help-email-visibility] in this organization can see the user's real email address. - 1 = Everyone - 2 =…
ProfileData
object
Only present if isbot is false; bots can't have custom profile fields. A dictionary containing custom profile field data for the user. Each entry maps the inte…
Reminder
object
Object containing details of the scheduled message.
8 properties
8 required
Event_types
array
A JSON-encoded array indicating which types of events you're interested in. Values that you might find useful include: - message (messages) - subscription (cha…
CanAdministerChannelGroup
ModernPresenceFormat
object
{userid}: Presence data (modern format) for the user with the specified ID.
2 properties
BotConfiguration
object
A dictionary of string key/value pairs, which describe the configuration for the bot. These are usually details like API keys, and are unique to the integratio…
UserBase
object
A dictionary containing basic data on a given Zulip user. Changes: Removed isbillingadmin field in Zulip 10.0 (feature level 363), as it was replaced by the ca…
18 properties
CanResolveTopicsGroup
UserGroup
object
Object containing the user group's attributes.
15 properties
EmojiReaction
Subscription
object
41 properties
GroupPermissionSetting
object
Configuration for a group permission setting specifying the groups to which the setting can be set to and the default values for the setting. Changes: Removed…
7 properties
LegacyPresenceFormat
object
{clientname} or "aggregated": Object containing the details of the user's presence. Changes: Starting with Zulip 7.0 (feature level 178), this will always cont…
4 properties
BasicChannelBase
object
Object containing basic details about the channel.
29 properties
OnboardingStep
object
Dictionary containing details of a single onboarding step.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zulip 12
Other APIs Zulip publishes across the network.
Zulip REST API
Zulip Events API
Zulip Webhooks
Zulip authentication API
Zulip bots API
Zulip channels API
Zulip drafts API
Zulip invites API
Zulip messages API
Zulip mobile API
Zulip navigation_views API
Zulip reminders API
#real_time_events