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

c5c1c302c431

sqs_trigger

get sqs trigger

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

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

queue_urlstring required

The full URL of the AWS SQS queue to poll for messages

aws_auth_resource_type'oidc' | 'credentials' required
aws_resource_pathstring required

Path to the AWS resource containing credentials or OIDC configuration

message_attributesstring[] nullable

Array of SQS message attribute names to include with each message

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

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