websocket_trigger

update websocket trigger

Changed on
post/w/{workspace}/websocket_triggers/update/{path}

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/update/{path}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required
pathstring required

Request body

urlstring required

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

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 a message is received

is_flowboolean required

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

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 to run when the triggered job fails. A bare path, without the script/ or flow/ prefix a schedule error handler takes; it cannot be a flow.

error_handler_argsScriptArgs

The arguments to pass to the script or flow

retryRetry (unresolved $ref)
permissioned_asstring

The user or group this trigger runs as. Used during deployment to preserve the original trigger owner.

preserve_permissioned_asboolean

When true and the caller is a member of the 'wm_deployers' group, preserves the original permissioned_as value instead of overwriting it.

labelsstring[]

Response

websocket trigger updated

Changes

  • 4f91ba605804Revision changes
    • breaking

      the / request property type changed from object to no type

    • warning

      removed the request property //

    • warning

      removed the request property //

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the / request property oneOf list