Pause Trigger

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

POST /v1/triggers/{trigger_id}/pause

Pause Trigger

cURL

curl --request POST \
  --url https://api.mixpeek.com/v1/triggers/{trigger_id}/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

200

{
  "namespace_id": "<string>",
  "internal_id": "<string>",
  "action_config": {},
  "schedule_config": {},
  "trigger_id": "<string>",
  "status": "active",
  "last_triggered_at": "2023-11-07T05:31:56Z",
  "last_execution_task_id": "<string>",
  "next_scheduled_at": "2023-11-07T05:31:56Z",
  "execution_count": 0,
  "consecutive_failures": 0,
  "last_execution_status": "<string>",
  "last_execution_error": "<string>",
  "event_counter": 0,
  "last_cooldown_at": "2023-11-07T05:31:56Z",
  "baseline_snapshot": {},
  "last_drift_measurement": {},
  "last_volume_measurement": {},
  "last_condition_check_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>"
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace · string · header · required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

trigger_id · string · required

Trigger ID

Response

200

application/json

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