Sign in
OpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-188273541007.0 KB

9183c3a03325

websocket_trigger

get websocket trigger

get/w/{workspace}/websocket_triggers/get/{path}

Path parameters

workspacestring required
pathstring required

Query parameters

get_draftboolean

When true, overlay the authed user's draft (if any) onto the deployed payload.

Response

websocket trigger deleted

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 required

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.

urlstring required

The WebSocket URL to connect to (can be a static URL or computed by a runnable)

server_idstring

ID of the server currently handling this trigger (internal)

last_server_pingstring date-time

Timestamp of last server heartbeat (internal)

errorstring

Last error message if the trigger failed

filter_logic'and' | 'or'

Logic to apply when evaluating the top-level filters. 'and' requires all of them to match, 'or' requires any of them to match. Nested any_of/all_of/none_of groups carry their own logic.

url_runnable_argsScriptArgs

The arguments to pass to the script or flow

can_return_messageboolean required

If true, the script can return a message to send back through the WebSocket

can_return_error_resultboolean required

If true, error results are sent back through the WebSocket

error_handler_pathstring

Path to a script or flow to run when the triggered job fails

error_handler_argsScriptArgs

The arguments to pass to the script or flow

retryRetry — unresolved $ref
draft_saved_atstring date-time
no_deployedboolean
draftobject