Skip to main content
GET
Get Trigger

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

trigger_id
string<uuid>
required
workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Response

Successful Response

Response model for trigger data.

agent_id
string<uuid>
required
conditions
Conditions · object
required
consecutive_failures
integer
required
created_at
string<date-time>
required
created_by
string
required
description
string
required
failure_threshold
integer
required
id
string<uuid>
required
is_active
boolean
required
name
string
required
status
enum<string>
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.

Available options:
active,
inactive,
needs_owner
task_parameters
Task Parameters · object
required
trigger_type
string
required
updated_at
string<date-time>
required
batch
TriggerBatchWindow · object | null

The batch window it fires per; null fires on every event.

cron_expression
string | null
event_filter
Event Filter · object | null

Which events fire it.

last_event_at
string<date-time> | null

When the trigger's stream last recorded an event.

last_execution_at
string<date-time> | null
needs_new_owner_at
string<date-time> | null
next_run_time
string<date-time> | null
session
TriggerSession · object | null

What the next event of the same session does; null takes the defaults.

stream_id
string<uuid> | null

Stream whose events fire this trigger.

task_definition_id
string<uuid> | null

Saved task each firing asks, in place of task_parameters.

timezone
string | null