Skip to main content
PATCH
/
v1
/
triggers
/
{trigger_id}
Update Trigger
curl --request PATCH \
  --url https://api.mixpeek.com/v1/triggers/{trigger_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schedule_config": {},
  "description": "<string>"
}
'
import requests

url = "https://api.mixpeek.com/v1/triggers/{trigger_id}"

payload = {
"schedule_config": {},
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({schedule_config: {}, description: '<string>'})
};

fetch('https://api.mixpeek.com/v1/triggers/{trigger_id}', 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/{trigger_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'schedule_config' => [

],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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/{trigger_id}"

payload := strings.NewReader("{\n \"schedule_config\": {},\n \"description\": \"<string>\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.mixpeek.com/v1/triggers/{trigger_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"schedule_config\": {},\n \"description\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/triggers/{trigger_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"schedule_config\": {},\n \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}

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

Body

application/json

Request to update an existing trigger.

Only provided fields will be updated.

schedule_config
Schedule Config · object | null

Updated schedule configuration

description
string | null

Updated description

status
enum<string> | null

Updated status

Available options:
active,
paused,
disabled,
failed

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