Link a plugin to a channel or a topic

POST https://runix.chat/api/v1/armada/plugins/{install_id}/links

Join a value the plugin understands, such as a project or a pool of machines, to a channel or to one of its topics. The plugin's widgets then show in that place's column, and its bot joins the channel.

Guests and bots cannot use this endpoint.

Changes: New in Zulip 13.0 (feature level ZF-0be29a).

Usage examples

curl

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for users and bots.

curl -sSX POST https://runix.chat/api/v1/armada/plugins/1/links \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode kind=project \
    --data-urlencode value=runix/nextlat-scaling \
    --data-urlencode stream_id=7 \
    --data-urlencode topic=lr-sweep

Parameters

install_id integer required in path

Example: 1

The ID of the plugin's install.

kind string required

Example: "project"

The kind of link, as the plugin's manifest names it.

value string required

Example: "runix/nextlat-scaling"

The value to link, which must match the manifest's pattern for that kind.

stream_id integer required

Example: 7

The ID of the channel.

topic string optional

Example: "lr-sweep"

The topic, for a link to one topic; without it, the link is to the whole channel.

Response

Return values

id: integer

The ID of the link.

Example response(s)

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 an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

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

API documentation home

Messages

Scheduled messages

Message reminders

Drafts

Navigation views

Channels

Users

Invitations

Server & organizations

Real-time events

Interactive bots

Armada plugins

Armada secrets