2.6 KiB

Raw Blame History

Get events from an event queue

{generate_api_description(/events:get)}

Usage examples

{start_tabs} {tab|python}

#!/usr/bin/env python

import sys
import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# If you already have a queue registered and thus, have a queue_id
# on hand, you may use client.get_events() and pass in the above
# arguments, like so:
print(client.get_events(
    queue_id="1515010080:4",
    last_event_id=-1
))

call_on_each_message and call_on_each_event will automatically register a queue for you.

{tab|js}

More examples and documentation can be found here.

const zulip = require('zulip-js');

// Pass the path to your zuliprc file here.
const config = {
    zuliprc: 'zuliprc',
};

zulip(config).then((client) => {
    // Register queue to receive messages for user
    const queueParams = {
        event_types: ['message']
    };
    client.queues.register(queueParams).then((res) => {
        // Retrieve events from a queue
        // Blocking until there is an event (or the request times out)
        const eventParams = {
            queue_id: res.queue_id,
            last_event_id: -1,
            dont_block: false,
        };
        client.events.retrieve(eventParams).then(console.log);
    });
});

{tab|curl}

{generate_code_example(curl, include=["queue_id", "last_event_id"])|/events:get|example}

{end_tabs}

Arguments

{generate_api_arguments_table|zulip.yaml|/events:get}

Note: The arguments documented above are optional in the sense that even if you haven't registered a queue by explicitly requesting the {{ api_url}}/v1/register endpoint, you could pass the arguments for the {{ api_url}}/v1/register endpoint to this endpoint and a queue would be registered in the absence of a queue_id.

Response

Return values

events: An array (possibly zero-length if dont_block is set) of events with IDs newer than last_event_id. Event IDs are guaranteed to be increasing, but they are not guaranteed to be consecutive.

Example response

A typical successful JSON response may look like:

{generate_code_example|/events:get|fixture(200)}

BAD_EVENT_QUEUE_ID errors

If the target event queue has been garbage collected, you'll get the following error response:

{generate_code_example|/events:get|fixture(400)}

A compliant client will handle this error by re-initializing itself (e.g. a Zulip webapp browser window will reload in this case).

See the /register endpoint docs for details on how to handle these correctly.

2.6 KiB Raw Blame History