Sign in
http_trigger

get http trigger

get/w/{workspace}/http_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

http 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.

route_pathstring required

The URL route path that will trigger this endpoint (e.g., 'api/myendpoint'). Must NOT start with a /.

http_method'get' | 'post' | 'put' | 'delete' | 'patch' required
authentication_resource_pathstring nullable

Path to the resource containing authentication configuration (for api_key, basic_http, custom_script, signature methods)

summarystring nullable

Short summary describing the purpose of this trigger

descriptionstring nullable

Detailed description of what this trigger does

request_type'sync' | 'async' | 'sync_sse' required
authentication_method'none' | 'windmill' | 'api_key' | 'basic_http' | 'custom_script' | 'signature' required
is_static_websiteboolean required

If true, serves static files from S3/storage instead of running a script

workspaced_routeboolean required

If true, the route includes the workspace ID in the path

wrap_bodyboolean required

If true, wraps the request body in a 'body' parameter

raw_stringboolean required

If true, passes the request body as a raw string instead of parsing as JSON

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

Changes