Skip to main content
POST
Pause 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
required

Trigger ID

Response

Successful Response

Unified trigger model for all action types.

A trigger defines:

  1. What to execute (action_type + action_config)
  2. When to execute (trigger_type + schedule_config)
  3. State tracking (execution count, failures, next scheduled time)
namespace_id
string
required

Namespace ID

internal_id
string
required

Organization internal ID

action_type
enum<string>
required

Type of action to execute

Available options:
cluster,
taxonomy_enrichment,
batch_rerun,
collection_trigger
action_config
Action Config · object
required

Action-specific configuration

trigger_type
enum<string>
required

Type of schedule

Available options:
cron,
interval,
event,
conditional
schedule_config
Schedule Config · object
required

Schedule-specific configuration

trigger_id
string

Unique trigger identifier

status
enum<string>
default:active

Current trigger status

Available options:
active,
paused,
disabled,
failed
last_triggered_at
string<date-time> | null

Last time trigger fired

last_execution_task_id
string | null

Task ID of last execution

next_scheduled_at
string<date-time> | null

Next scheduled execution time

execution_count
integer
default:0

Total successful executions

consecutive_failures
integer
default:0

Consecutive failures

last_execution_status
string | null

Status of last execution

last_execution_error
string | null

Error from last execution (if failed)

event_counter
integer
default:0

Current event count since last trigger

last_cooldown_at
string<date-time> | null

Last time cooldown was applied

baseline_snapshot
Baseline Snapshot · object | null

Baseline snapshot for drift measurement (captured after successful execution)

last_drift_measurement
Last Drift Measurement · object | null

Result of most recent drift measurement check

last_volume_measurement
Last Volume Measurement · object | null

Result of most recent volume (document count) condition check

last_condition_check_at
string<date-time> | null

When condition was last evaluated

description
string | null

Human-readable description

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

created_by
string | null

User who created trigger