curl --request POST \
--url https://api.mixpeek.com/v1/triggers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"action_config": {
"cluster_id": "clust_abc123"
},
"action_type": "cluster",
"description": "Daily clustering at 2am",
"schedule_config": {
"cron_expression": "0 2 * * *",
"timezone": "UTC"
},
"trigger_type": "cron"
}
'import requests
url = "https://api.mixpeek.com/v1/triggers"
payload = {
"action_config": { "cluster_id": "clust_abc123" },
"action_type": "cluster",
"description": "Daily clustering at 2am",
"schedule_config": {
"cron_expression": "0 2 * * *",
"timezone": "UTC"
},
"trigger_type": "cron"
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
action_config: {cluster_id: 'clust_abc123'},
action_type: 'cluster',
description: 'Daily clustering at 2am',
schedule_config: {cron_expression: '0 2 * * *', timezone: 'UTC'},
trigger_type: 'cron'
})
};
fetch('https://api.mixpeek.com/v1/triggers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/triggers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action_config' => [
'cluster_id' => 'clust_abc123'
],
'action_type' => 'cluster',
'description' => 'Daily clustering at 2am',
'schedule_config' => [
'cron_expression' => '0 2 * * *',
'timezone' => 'UTC'
],
'trigger_type' => 'cron'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/triggers"
payload := strings.NewReader("{\n \"action_config\": {\n \"cluster_id\": \"clust_abc123\"\n },\n \"action_type\": \"cluster\",\n \"description\": \"Daily clustering at 2am\",\n \"schedule_config\": {\n \"cron_expression\": \"0 2 * * *\",\n \"timezone\": \"UTC\"\n },\n \"trigger_type\": \"cron\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/triggers")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action_config\": {\n \"cluster_id\": \"clust_abc123\"\n },\n \"action_type\": \"cluster\",\n \"description\": \"Daily clustering at 2am\",\n \"schedule_config\": {\n \"cron_expression\": \"0 2 * * *\",\n \"timezone\": \"UTC\"\n },\n \"trigger_type\": \"cron\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/triggers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action_config\": {\n \"cluster_id\": \"clust_abc123\"\n },\n \"action_type\": \"cluster\",\n \"description\": \"Daily clustering at 2am\",\n \"schedule_config\": {\n \"cron_expression\": \"0 2 * * *\",\n \"timezone\": \"UTC\"\n },\n \"trigger_type\": \"cron\"\n}"
response = http.request(request)
puts response.read_body{
"namespace_id": "<string>",
"internal_id": "<string>",
"action_type": "cluster",
"action_config": {},
"trigger_type": "cron",
"schedule_config": {},
"is_overdue": true,
"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",
"name": "<string>",
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>"
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Create Trigger
Create a new trigger for scheduled job execution.
Action Types:
cluster: Execute clustering on a cluster definitiontaxonomy_enrichment: Apply taxonomy enrichment to a collection
Schedule Types:
cron: Execute at specific times using cron expressions (e.g., “0 2 * * *” for daily at 2am)interval: Execute at fixed intervals (e.g., every 6 hours)event: Execute when specific events occur (e.g., after 100 documents added)conditional: Execute when conditions are met (e.g., drift threshold exceeded)
Examples:
Cluster trigger (daily at 2am):
{
"action_type": "cluster",
"action_config": {"cluster_id": "clust_abc123"},
"trigger_type": "cron",
"schedule_config": {"cron_expression": "0 2 * * *", "timezone": "UTC"},
"description": "Daily clustering at 2am"
}
Taxonomy enrichment trigger (every 6 hours):
{
"action_type": "taxonomy_enrichment",
"action_config": {
"taxonomy_id": "tax_products",
"collection_id": "col_inventory",
"batch_size": 1000
},
"trigger_type": "interval",
"schedule_config": {"interval_seconds": 21600},
"description": "Re-enrich products every 6 hours"
}
curl --request POST \
--url https://api.mixpeek.com/v1/triggers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"action_config": {
"cluster_id": "clust_abc123"
},
"action_type": "cluster",
"description": "Daily clustering at 2am",
"schedule_config": {
"cron_expression": "0 2 * * *",
"timezone": "UTC"
},
"trigger_type": "cron"
}
'import requests
url = "https://api.mixpeek.com/v1/triggers"
payload = {
"action_config": { "cluster_id": "clust_abc123" },
"action_type": "cluster",
"description": "Daily clustering at 2am",
"schedule_config": {
"cron_expression": "0 2 * * *",
"timezone": "UTC"
},
"trigger_type": "cron"
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
action_config: {cluster_id: 'clust_abc123'},
action_type: 'cluster',
description: 'Daily clustering at 2am',
schedule_config: {cron_expression: '0 2 * * *', timezone: 'UTC'},
trigger_type: 'cron'
})
};
fetch('https://api.mixpeek.com/v1/triggers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/triggers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action_config' => [
'cluster_id' => 'clust_abc123'
],
'action_type' => 'cluster',
'description' => 'Daily clustering at 2am',
'schedule_config' => [
'cron_expression' => '0 2 * * *',
'timezone' => 'UTC'
],
'trigger_type' => 'cron'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/triggers"
payload := strings.NewReader("{\n \"action_config\": {\n \"cluster_id\": \"clust_abc123\"\n },\n \"action_type\": \"cluster\",\n \"description\": \"Daily clustering at 2am\",\n \"schedule_config\": {\n \"cron_expression\": \"0 2 * * *\",\n \"timezone\": \"UTC\"\n },\n \"trigger_type\": \"cron\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/triggers")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action_config\": {\n \"cluster_id\": \"clust_abc123\"\n },\n \"action_type\": \"cluster\",\n \"description\": \"Daily clustering at 2am\",\n \"schedule_config\": {\n \"cron_expression\": \"0 2 * * *\",\n \"timezone\": \"UTC\"\n },\n \"trigger_type\": \"cron\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/triggers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action_config\": {\n \"cluster_id\": \"clust_abc123\"\n },\n \"action_type\": \"cluster\",\n \"description\": \"Daily clustering at 2am\",\n \"schedule_config\": {\n \"cron_expression\": \"0 2 * * *\",\n \"timezone\": \"UTC\"\n },\n \"trigger_type\": \"cron\"\n}"
response = http.request(request)
puts response.read_body{
"namespace_id": "<string>",
"internal_id": "<string>",
"action_type": "cluster",
"action_config": {},
"trigger_type": "cron",
"schedule_config": {},
"is_overdue": true,
"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",
"name": "<string>",
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>"
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Authorizations
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, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.
Body
Keys this body does not declare are refused with 422 extra_forbidden naming the accepted keys (since 2026-11-02).
Request to create a new trigger.
Examples: Cluster trigger (cron): { "action_type": "cluster", "action_config": {"cluster_id": "clust_abc123"}, "trigger_type": "cron", "schedule_config": {"cron_expression": "0 2 * * *", "timezone": "UTC"}, "description": "Daily clustering at 2am" }
Taxonomy trigger (interval):
{
"action_type": "taxonomy_enrichment",
"action_config": {"taxonomy_id": "tax_products", "collection_id": "col_inv"},
"trigger_type": "interval",
"schedule_config": {"interval_seconds": 21600},
"description": "Re-enrich every 6 hours"
}
Response
Successful Response
Unified trigger model for all action types.
A trigger defines:
- What to execute (action_type + action_config)
- When to execute (trigger_type + schedule_config)
- State tracking (execution count, failures, next scheduled time)
Whether this trigger is active, scheduled by next_scheduled_at (cron, interval, or conditional), and that time has already passed.
next_scheduled_at is naive (implicitly UTC) right after creation -- _calculate_next_cron (shared/triggers/utils.py) strips tzinfo before returning -- and aware once round-tripped through Mongo (tz_aware=True on both providers). Compare on the naive side so both cases work.
Was this page helpful?

