websocket_trigger

list websocket triggers

Changed on
get/w/{workspace}/websocket_triggers/list

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/websocket_triggers/list
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

pageinteger

which page to return (start at 1, default 1)

per_pageinteger

number of items to return for a given page (default 30, max 100)

pathstring

filter by path

is_flowboolean
path_startstring
labelstring

Filter by label

include_draft_onlyboolean

When true, append per-user draft rows whose path has no deployed counterpart. Synthesized rows carry draft_only: true so the home page can render a "Draft" badge. Gated to non-operators + page 0 + no narrowing filters on the backend so picker callers stay deployed-only and pagination stays clean.

Response

websocket trigger list

pathstring required

The unique Windmill path for this trigger. Must be of the form u/<user>/<path> or f/<folder>/<path>. This is the trigger object path, not the HTTP route path.

script_pathstring required

Path to the script or flow to execute when triggered

permissioned_asstring required

The user or group this trigger runs as (permissioned_as)

extra_permsobject required

Additional permissions for this trigger

workspace_idstring required

The workspace this trigger belongs to

edited_bystring required

Username of the last person who edited this trigger

edited_atstring date-time required

Timestamp of the last edit

is_flowboolean required

True if script_path points to a flow, false if it points to a script

mode'enabled' | 'disabled' | 'suspended' required

job trigger mode

labelsstring[]
draft_onlyboolean

True when this row is a per-user draft with no deployed trigger at the same path. Set by list endpoints when include_draft_only=true synthesizes the row from the draft. Frontend renders a "Draft" badge.

is_draftboolean

True when the authed user has a per-user draft at this path (over a deployed row or a synthesized draft-only row). Frontend appends a * to the displayed name.

Changes

  • 4f91ba605804Revision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the // response property oneOf list for the response status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status