AGagentarea
v1
protected
triggers

List Triggers

Changed on

List the workspace's triggers, by agent, type and active state.

get/v1/workspaces/{workspace}/triggers/

Request

Path parameters

workspacestring required

Slug of the workspace the request acts in

Query parameters

agent_idstring uuid nullable

Filter by agent ID

trigger_type'cron' | 'stream'

Types of triggers supported by the system.

Filter by trigger type (cron, stream)

active_onlyboolean

Only return active triggers

limitinteger

Maximum number of triggers to return

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 optional property / to the response with the status

  • 1d8a3995ec6cRevision changes
    • 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 optional property / to the response with the status

    • info

      added the optional property / to the response with the status