Sign in
latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-158263541004.1 KB

a7f071808448

gcp_trigger

update gcp trigger

post/w/{workspace}/gcp_triggers/update/{path}

Path parameters

workspacestring required
pathstring required

Request body

gcp_resource_pathstring required

Path to the GCP resource containing service account credentials for authentication.

subscription_mode'existing' | 'create_update' required

The mode of subscription. 'existing' means using an existing GCP subscription, while 'create_update' involves creating or updating a new subscription.

topic_idstring required

Google Cloud Pub/Sub topic ID to subscribe to.

subscription_idstring

Google Cloud Pub/Sub subscription ID.

base_endpointstring

Base URL for push delivery endpoint.

delivery_type'push' | 'pull'

Delivery mode for messages. 'push' for HTTP push delivery where messages are sent to a webhook endpoint, 'pull' for polling where the trigger actively fetches messages.

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.

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

job trigger mode

auto_acknowledge_msgboolean

If true, automatically acknowledge messages after processing.

ack_deadlineinteger

Time in seconds within which the message must be acknowledged. If not provided, defaults to the subscription's acknowledgment deadline (600 seconds).

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

gcp trigger updated