Skip to main content
GET
/
v1
/
triggers
/
{trigger_id}
Get Trigger
curl --request GET \
  --url https://api.mixpeek.com/v1/triggers/{trigger_id}
{
  "namespace_id": "<string>",
  "internal_id": "<string>",
  "action_type": "cluster",
  "action_config": {},
  "trigger_type": "cron",
  "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_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>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

authorization
string
X-Namespace
string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

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

Baseline snapshot for drift measurement (captured after successful execution)

last_drift_measurement
Last Drift Measurement · object

Result of most recent drift measurement 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