Get a plugin's recent activity

GET https://runix.chat/api/v1/armada/plugins/{install_id}/recent

Who did what to a plugin, newest first: installs and updates, changes to its settings, links, removals and their undoing, the tool actions people ran, and the times its process started.

A line about a channel the user cannot read is left out. What a line records names a secret but never holds its value.

Guests and bots cannot use this endpoint.

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

Usage examples

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

curl -sSX GET -G https://runix.chat/api/v1/armada/plugins/1/recent \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode limit=20

Parameters

install_id integer required in path

Example: 1

The ID of the plugin's install.


limit integer optional

Example: 20

The most lines to return, between 1 and 100.

Defaults to 50.


Response

Return values

  • recent: (object)[]

    The plugin's activity, newest first.

    • id: integer

      The line's ID.

    • type: string

      What happened. made is a plugin the agent made for someone; started is the first push of a newly started process.

    • acting_user_id: integer | null

      Who did it: a person, or the plugin's own bot for started.

    • time: integer

      When, as a UNIX timestamp.

    • stream_id: integer | null

      The channel the line is about, for a link or a tool action in a linked place.

    • detail: object

      What the line records: for example the version, the settings before and after, the names of the secrets set, the link, or the tool and whether it failed.

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:

{
    "msg": "",
    "recent": [
        {
            "acting_user_id": 11,
            "detail": {
                "kind": "project",
                "link_id": 2,
                "topic": null,
                "value": "runix/nextlat-scaling"
            },
            "id": 31,
            "stream_id": 3,
            "time": 1760600000,
            "type": "linked"
        },
        {
            "acting_user_id": 11,
            "detail": {
                "secrets": [
                    "api_key"
                ],
                "settings": {
                    "entity": "runix"
                },
                "sha": "4e1d2c3b4a5968778695a4b3c2d1e0f9a8b7c6d5",
                "source": "github.com/plugyawn/armada-wandb",
                "source_kind": "github",
                "source_path": "",
                "version": "0.4.1"
            },
            "id": 30,
            "stream_id": null,
            "time": 1760599000,
            "type": "installed"
        }
    ],
    "result": "success"
}