Sign in
Triggers

Pause Trigger

Pause trigger execution. Paused triggers retain configuration but do not execute.

post/v1/triggers/{trigger_id}/pause

Path parameters

trigger_idstring required

Trigger ID

Trigger ID

Response

Successful Response

trigger_idstring

Unique trigger identifier

namespace_idstring required

Namespace ID

internal_idstring required

Organization internal ID

action_type'cluster' | 'taxonomy_enrichment' | 'batch_rerun' | 'collection_trigger' required

Type of action to execute when trigger fires.

Supported action types:

  • cluster: Execute clustering on a cluster definition
  • taxonomy_enrichment: Apply taxonomy enrichment to a collection
  • batch_rerun: Re-execute a completed/failed batch
action_configobject required

Action-specific configuration

trigger_type'cron' | 'interval' | 'event' | 'conditional' required

Type of trigger schedule.

Supported trigger types:

  • cron: Schedule-based execution using cron expressions
  • interval: Fixed-interval execution
  • event: Event-driven execution
  • conditional: Condition-based execution
schedule_configobject required

Schedule-specific configuration

status'active' | 'paused' | 'disabled' | 'failed'

Status of a trigger.

last_triggered_atstring date-time nullable

Last time trigger fired

last_execution_task_idstring nullable

Task ID of last execution

next_scheduled_atstring date-time nullable

Next scheduled execution time

execution_countinteger

Total successful executions

consecutive_failuresinteger

Consecutive failures

last_execution_statusstring nullable

Status of last execution

last_execution_errorstring nullable

Error from last execution (if failed)

event_counterinteger

Current event count since last trigger

last_cooldown_atstring date-time nullable

Last time cooldown was applied

baseline_snapshotobject nullable

Baseline snapshot for drift measurement (captured after successful execution)

last_drift_measurementobject nullable

Result of most recent drift measurement check

last_volume_measurementobject nullable

Result of most recent volume (document count) condition check

last_condition_check_atstring date-time nullable

When condition was last evaluated

namestring nullable

Human-readable trigger name (surfaced in list/get responses)

descriptionstring nullable

Human-readable description

created_atstring date-time

Creation timestamp

updated_atstring date-time

Last update timestamp

created_bystring nullable

User who created trigger

Changes

Changed in 2 of the 31 revisions of this API.2