AGagentarea
v1
protected
triggers

Update Trigger

Changed on

Update an existing trigger; only the fields sent change.

Raises: HTTPException: 404 if the trigger does not exist; 400 if validation fails; 409 if the update changes the filter of a trigger that has no stream subscription left.

put/v1/workspaces/{workspace}/triggers/{trigger_id}

Request

Path parameters

trigger_idstring uuid required
workspacestring required

Slug of the workspace the request acts in

Request body

agent_idstring uuid nullable
conditionsobject nullable
cron_expressionstring nullable
descriptionstring nullable
enabledboolean nullable

Toggle the trigger active state. Maps to is_active server-side. REST clients may pass either enabled (canonical) or is_active (alias).

event_filterobject nullable
failure_thresholdinteger nullable
namestring nullable
task_definition_idstring uuid nullable

Sent as null, the trigger asks its own task_parameters text again.

task_parametersobject nullable
timezonestring nullable

Response

Successful Response

agent_idstring uuid required
conditionsobject required
consecutive_failuresinteger required
created_atstring date-time required
created_bystring required
cron_expressionstring nullable
descriptionstring required
event_filterobject nullable

Which events fire it.

failure_thresholdinteger required
idstring uuid required
is_activeboolean required
last_event_atstring date-time nullable

When the trigger's stream last recorded an event.

last_execution_atstring date-time nullable
namestring required
needs_new_owner_atstring date-time nullable
next_run_timestring date-time nullable
status'active' | 'inactive' | 'needs_owner' required

'needs_owner' when the person who configured it can no longer run its agent; the trigger stays stopped until it is enabled again, and the next event re-checks that person's access.

stream_idstring uuid nullable

Stream whose events fire this trigger.

task_definition_idstring uuid nullable

Saved task each firing asks, in place of task_parameters.

task_parametersobject required
timezonestring nullable
trigger_typestring required
updated_atstring date-time required

Changes

  • 1868622eed6dRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 1d8a3995ec6cRevision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status