Delete an event queue

Delete a previously registered queue.

DELETE https://chat.fhir.org/api/v1/events

Usage examples

#!/usr/bin/env python3

import zulip

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

# Delete a queue (queue_id is the ID of the queue
# to be removed)
result = client.deregister(queue_id)
print(result)

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(async (client) => {
    // Register a queue
    const queueParams = {
        event_types: ["message"],
    };
    const res = await client.queues.register(queueParams);

    // Delete a queue
    const deregisterParams = {
        queue_id: res.queue_id,
    };

    return await client.queues.deregister(deregisterParams);
}).then(console.log).catch(console.err);

curl -sSX DELETE https://chat.fhir.org/api/v1/events \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d 'queue_id=1375801870:2942'

Parameters

queue_id required

Example: 1375801870:2942

The ID of an event queue that was previously registered via POST /api/v1/register (see Register a queue).


Response

Example response

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}

A typical JSON response for when the queue_id is non-existent or the associated queue has already been deleted:

{
    "code": "BAD_EVENT_QUEUE_ID",
    "msg": "Bad event queue id: 1518820930:1",
    "queue_id": "1518820930:1",
    "result": "error"
}