Update Trigger

PUT

workspaces

{workspace}

triggers

{trigger_id}

Update Trigger

curl --request PUT \
  --url https://api.example.com/v1/workspaces/{workspace}/triggers/{trigger_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch": {
    "max_events": 3,
    "window": "<string>"
  },
  "conditions": {},
  "cron_expression": "<string>",
  "description": "<string>",
  "enabled": true,
  "event_filter": {},
  "failure_threshold": 50,
  "name": "<string>",
  "session": {
    "continue": true,
    "idle_timeout": "<string>"
  },
  "task_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_parameters": {},
  "timezone": "<string>"
}
'

import requests

url = "https://api.example.com/v1/workspaces/{workspace}/triggers/{trigger_id}"

payload = {
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "batch": {
        "max_events": 3,
        "window": "<string>"
    },
    "conditions": {},
    "cron_expression": "<string>",
    "description": "<string>",
    "enabled": True,
    "event_filter": {},
    "failure_threshold": 50,
    "name": "<string>",
    "session": {
        "continue": True,
        "idle_timeout": "<string>"
    },
    "task_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "task_parameters": {},
    "timezone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    batch: {max_events: 3, window: '<string>'},
    conditions: {},
    cron_expression: '<string>',
    description: '<string>',
    enabled: true,
    event_filter: {},
    failure_threshold: 50,
    name: '<string>',
    session: {continue: true, idle_timeout: '<string>'},
    task_definition_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    task_parameters: {},
    timezone: '<string>'
  })
};

fetch('https://api.example.com/v1/workspaces/{workspace}/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.example.com/v1/workspaces/{workspace}/triggers/{trigger_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'batch' => [
        'max_events' => 3,
        'window' => '<string>'
    ],
    'conditions' => [
        
    ],
    'cron_expression' => '<string>',
    'description' => '<string>',
    'enabled' => true,
    'event_filter' => [
        
    ],
    'failure_threshold' => 50,
    'name' => '<string>',
    'session' => [
        'continue' => true,
        'idle_timeout' => '<string>'
    ],
    'task_definition_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'task_parameters' => [
        
    ],
    'timezone' => '<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.example.com/v1/workspaces/{workspace}/triggers/{trigger_id}"

	payload := strings.NewReader("{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batch\": {\n    \"max_events\": 3,\n    \"window\": \"<string>\"\n  },\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"event_filter\": {},\n  \"failure_threshold\": 50,\n  \"name\": \"<string>\",\n  \"session\": {\n    \"continue\": true,\n    \"idle_timeout\": \"<string>\"\n  },\n  \"task_definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_parameters\": {},\n  \"timezone\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/v1/workspaces/{workspace}/triggers/{trigger_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batch\": {\n    \"max_events\": 3,\n    \"window\": \"<string>\"\n  },\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"event_filter\": {},\n  \"failure_threshold\": 50,\n  \"name\": \"<string>\",\n  \"session\": {\n    \"continue\": true,\n    \"idle_timeout\": \"<string>\"\n  },\n  \"task_definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_parameters\": {},\n  \"timezone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batch\": {\n    \"max_events\": 3,\n    \"window\": \"<string>\"\n  },\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"event_filter\": {},\n  \"failure_threshold\": 50,\n  \"name\": \"<string>\",\n  \"session\": {\n    \"continue\": true,\n    \"idle_timeout\": \"<string>\"\n  },\n  \"task_definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_parameters\": {},\n  \"timezone\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conditions": {},
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "description": "<string>",
  "failure_threshold": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "name": "<string>",
  "status": "active",
  "task_parameters": {},
  "trigger_type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "batch": {
    "max_events": 3,
    "window": "<string>"
  },
  "cron_expression": "<string>",
  "event_filter": {},
  "last_event_at": "2023-11-07T05:31:56Z",
  "last_execution_at": "2023-11-07T05:31:56Z",
  "needs_new_owner_at": "2023-11-07T05:31:56Z",
  "next_run_time": "2023-11-07T05:31:56Z",
  "session": {
    "continue": true,
    "idle_timeout": "<string>"
  },
  "stream_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timezone": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

trigger_id

string<uuid>

required

workspace

string

required

Slug of the workspace the request acts in

Maximum string length: 120

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

Patch payload for a trigger. All fields optional — unset = unchanged.

agent_id

string<uuid> | null

batch

TriggerBatchWindow · object | null

Sent as null, the trigger fires on every event again.

Show child attributes

conditions

Conditions · object | null

cron_expression

string | null

description

string | null

Maximum string length: 1000

enabled

boolean | null

Toggle the trigger active state. Maps to is_active server-side. REST clients may pass either enabled (canonical) or is_active (alias).

event_filter

Event Filter · object | null

failure_threshold

integer | null

Required range: 1 <= x <= 100

name

string | null

Required string length: 1 - 255

session

TriggerSession · object | null

What happens to the next event of the same session (ADR-0040 §4).

Show child attributes

task_definition_id

string<uuid> | null

Sent as null, the trigger asks its own task_parameters text again.

task_parameters

Task Parameters · object | null

timezone

string | null

Response

Successful Response

Response model for trigger data.

agent_id

string<uuid>

required

conditions

Conditions · object

required

consecutive_failures

integer

required

created_at

string<date-time>

required

created_by

string

required

description

string

required

failure_threshold

integer

required

string<uuid>

required

is_active

boolean

required

name

string

required

status

enum<string>

required

'needs_owner' when the person who configured it can no longer run its agent; the trigger stays stopped until it is enabled again, and the next event re-checks that person's access.

Available options:

active,

inactive,

needs_owner

task_parameters

Task Parameters · object

required

trigger_type

string

required

updated_at

string<date-time>

required

batch

TriggerBatchWindow · object | null

The batch window it fires per; null fires on every event.

Show child attributes

cron_expression

string | null

event_filter

Event Filter · object | null

Which events fire it.

last_event_at

string<date-time> | null

When the trigger's stream last recorded an event.

last_execution_at

string<date-time> | null

needs_new_owner_at

string<date-time> | null

next_run_time

string<date-time> | null

session

TriggerSession · object | null

What the next event of the same session does; null takes the defaults.

Show child attributes

stream_id

string<uuid> | null

Stream whose events fire this trigger.

task_definition_id

string<uuid> | null

Saved task each firing asks, in place of task_parameters.

timezone

string | null

Update Trigger

curl --request PUT \
  --url https://api.example.com/v1/workspaces/{workspace}/triggers/{trigger_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch": {
    "max_events": 3,
    "window": "<string>"
  },
  "conditions": {},
  "cron_expression": "<string>",
  "description": "<string>",
  "enabled": true,
  "event_filter": {},
  "failure_threshold": 50,
  "name": "<string>",
  "session": {
    "continue": true,
    "idle_timeout": "<string>"
  },
  "task_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_parameters": {},
  "timezone": "<string>"
}
'

import requests

url = "https://api.example.com/v1/workspaces/{workspace}/triggers/{trigger_id}"

payload = {
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "batch": {
        "max_events": 3,
        "window": "<string>"
    },
    "conditions": {},
    "cron_expression": "<string>",
    "description": "<string>",
    "enabled": True,
    "event_filter": {},
    "failure_threshold": 50,
    "name": "<string>",
    "session": {
        "continue": True,
        "idle_timeout": "<string>"
    },
    "task_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "task_parameters": {},
    "timezone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    batch: {max_events: 3, window: '<string>'},
    conditions: {},
    cron_expression: '<string>',
    description: '<string>',
    enabled: true,
    event_filter: {},
    failure_threshold: 50,
    name: '<string>',
    session: {continue: true, idle_timeout: '<string>'},
    task_definition_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    task_parameters: {},
    timezone: '<string>'
  })
};

fetch('https://api.example.com/v1/workspaces/{workspace}/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.example.com/v1/workspaces/{workspace}/triggers/{trigger_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'batch' => [
        'max_events' => 3,
        'window' => '<string>'
    ],
    'conditions' => [
        
    ],
    'cron_expression' => '<string>',
    'description' => '<string>',
    'enabled' => true,
    'event_filter' => [
        
    ],
    'failure_threshold' => 50,
    'name' => '<string>',
    'session' => [
        'continue' => true,
        'idle_timeout' => '<string>'
    ],
    'task_definition_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'task_parameters' => [
        
    ],
    'timezone' => '<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.example.com/v1/workspaces/{workspace}/triggers/{trigger_id}"

	payload := strings.NewReader("{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batch\": {\n    \"max_events\": 3,\n    \"window\": \"<string>\"\n  },\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"event_filter\": {},\n  \"failure_threshold\": 50,\n  \"name\": \"<string>\",\n  \"session\": {\n    \"continue\": true,\n    \"idle_timeout\": \"<string>\"\n  },\n  \"task_definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_parameters\": {},\n  \"timezone\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/v1/workspaces/{workspace}/triggers/{trigger_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batch\": {\n    \"max_events\": 3,\n    \"window\": \"<string>\"\n  },\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"event_filter\": {},\n  \"failure_threshold\": 50,\n  \"name\": \"<string>\",\n  \"session\": {\n    \"continue\": true,\n    \"idle_timeout\": \"<string>\"\n  },\n  \"task_definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_parameters\": {},\n  \"timezone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"batch\": {\n    \"max_events\": 3,\n    \"window\": \"<string>\"\n  },\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"event_filter\": {},\n  \"failure_threshold\": 50,\n  \"name\": \"<string>\",\n  \"session\": {\n    \"continue\": true,\n    \"idle_timeout\": \"<string>\"\n  },\n  \"task_definition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_parameters\": {},\n  \"timezone\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conditions": {},
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "description": "<string>",
  "failure_threshold": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "name": "<string>",
  "status": "active",
  "task_parameters": {},
  "trigger_type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "batch": {
    "max_events": 3,
    "window": "<string>"
  },
  "cron_expression": "<string>",
  "event_filter": {},
  "last_event_at": "2023-11-07T05:31:56Z",
  "last_execution_at": "2023-11-07T05:31:56Z",
  "needs_new_owner_at": "2023-11-07T05:31:56Z",
  "next_run_time": "2023-11-07T05:31:56Z",
  "session": {
    "continue": true,
    "idle_timeout": "<string>"
  },
  "stream_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timezone": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Start here

Concepts

Guides

Self-host

Reference

API reference

API endpoints

Community

Authorizations

Path Parameters

Body

Response