Create Trigger

Create a new trigger.

Creates a new trigger with the specified configuration. The trigger will be validated and, if it’s a cron trigger, automatically scheduled.

If channel_credentials are provided, they are stored encrypted in the secret store under key channel_cred:{webhook_type}:{trigger_id}.

Args: payload: Trigger creation DTO (single source of truth shared with MCP toolset). user_context: Authentication context. trigger_service: Injected trigger service. secret_manager: Injected secret manager for credential storage.

Returns: The created trigger.

Raises: HTTPException: If validation fails or creation errors occur.

POST

triggers

Create Trigger

curl --request POST \
  --url https://api.example.com/v1/triggers/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "allowed_methods": [
    "<string>"
  ],
  "channel_credentials": {},
  "conditions": {},
  "cron_expression": "<string>",
  "data_extractor": "<string>",
  "data_extractor_config": {},
  "description": "",
  "enabled": true,
  "event_types": [
    "<string>"
  ],
  "failure_threshold": 5,
  "task_parameters": {},
  "timezone": "UTC",
  "validation_rules": {},
  "webhook_config": {},
  "webhook_id": "<string>",
  "webhook_type": "generic"
}
'

import requests

url = "https://api.example.com/v1/triggers/"

payload = {
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "allowed_methods": ["<string>"],
    "channel_credentials": {},
    "conditions": {},
    "cron_expression": "<string>",
    "data_extractor": "<string>",
    "data_extractor_config": {},
    "description": "",
    "enabled": True,
    "event_types": ["<string>"],
    "failure_threshold": 5,
    "task_parameters": {},
    "timezone": "UTC",
    "validation_rules": {},
    "webhook_config": {},
    "webhook_id": "<string>",
    "webhook_type": "generic"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    allowed_methods: ['<string>'],
    channel_credentials: {},
    conditions: {},
    cron_expression: '<string>',
    data_extractor: '<string>',
    data_extractor_config: {},
    description: '',
    enabled: true,
    event_types: ['<string>'],
    failure_threshold: 5,
    task_parameters: {},
    timezone: 'UTC',
    validation_rules: {},
    webhook_config: {},
    webhook_id: '<string>',
    webhook_type: 'generic'
  })
};

fetch('https://api.example.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.example.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([
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'allowed_methods' => [
        '<string>'
    ],
    'channel_credentials' => [
        
    ],
    'conditions' => [
        
    ],
    'cron_expression' => '<string>',
    'data_extractor' => '<string>',
    'data_extractor_config' => [
        
    ],
    'description' => '',
    'enabled' => true,
    'event_types' => [
        '<string>'
    ],
    'failure_threshold' => 5,
    'task_parameters' => [
        
    ],
    'timezone' => 'UTC',
    'validation_rules' => [
        
    ],
    'webhook_config' => [
        
    ],
    'webhook_id' => '<string>',
    'webhook_type' => 'generic'
  ]),
  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/triggers/"

	payload := strings.NewReader("{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"allowed_methods\": [\n    \"<string>\"\n  ],\n  \"channel_credentials\": {},\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"data_extractor\": \"<string>\",\n  \"data_extractor_config\": {},\n  \"description\": \"\",\n  \"enabled\": true,\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"failure_threshold\": 5,\n  \"task_parameters\": {},\n  \"timezone\": \"UTC\",\n  \"validation_rules\": {},\n  \"webhook_config\": {},\n  \"webhook_id\": \"<string>\",\n  \"webhook_type\": \"generic\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.example.com/v1/triggers/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"allowed_methods\": [\n    \"<string>\"\n  ],\n  \"channel_credentials\": {},\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"data_extractor\": \"<string>\",\n  \"data_extractor_config\": {},\n  \"description\": \"\",\n  \"enabled\": true,\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"failure_threshold\": 5,\n  \"task_parameters\": {},\n  \"timezone\": \"UTC\",\n  \"validation_rules\": {},\n  \"webhook_config\": {},\n  \"webhook_id\": \"<string>\",\n  \"webhook_type\": \"generic\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.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["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"allowed_methods\": [\n    \"<string>\"\n  ],\n  \"channel_credentials\": {},\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"data_extractor\": \"<string>\",\n  \"data_extractor_config\": {},\n  \"description\": \"\",\n  \"enabled\": true,\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"failure_threshold\": 5,\n  \"task_parameters\": {},\n  \"timezone\": \"UTC\",\n  \"validation_rules\": {},\n  \"webhook_config\": {},\n  \"webhook_id\": \"<string>\",\n  \"webhook_type\": \"generic\"\n}"

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

{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conditions": {},
  "consecutive_failures": 123,
  "created_at": "<string>",
  "created_by": "<string>",
  "description": "<string>",
  "failure_threshold": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "name": "<string>",
  "task_parameters": {},
  "trigger_type": "<string>",
  "updated_at": "<string>",
  "allowed_methods": [
    "<string>"
  ],
  "cron_expression": "<string>",
  "data_extractor": "<string>",
  "event_types": [
    "<string>"
  ],
  "has_channel_credentials": false,
  "last_execution_at": "<string>",
  "next_run_time": "<string>",
  "timezone": "<string>",
  "validation_rules": {},
  "webhook_config": {},
  "webhook_id": "<string>",
  "webhook_type": "<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.

Body

application/json

Payload for creating a trigger.

A trigger fires an agent — either on a cron schedule (trigger_type='cron') or in response to an inbound webhook (trigger_type='webhook'). For poll-based channels (e.g. email inbox), use trigger_type='polling' plus a data_extractor configuration.

agent_id

string<uuid>

required

UUID of the agent to invoke when the trigger fires.

name

string

required

Human-readable trigger name.

Required string length: 1 - 255

trigger_type

enum<string>

required

'cron' for scheduled, 'webhook' for inbound HTTP, 'polling' for extractor-driven.

Available options:

cron,

webhook,

polling

allowed_methods

string[]

HTTP methods accepted on the webhook endpoint.

channel_credentials

Channel Credentials · object | null

Channel credentials (bot_token, SMTP password, etc). Stored encrypted in the secret store. Never returned in responses.

conditions

Conditions · object

Optional conditions evaluated against event data before firing.

cron_expression

string | null

5- or 6-field cron expression (required when trigger_type='cron').

data_extractor

string | null

Polling extractor identifier (e.g. 'imap', 'rss').

data_extractor_config

Data Extractor Config · object | null

Connection/auth details for the polling extractor.

description

string

default:""

Short summary of what this trigger does.

Maximum string length: 1000

enabled

boolean

default:true

Whether the trigger is active immediately on creation.

event_types

string[]

Event types to filter on (empty list = accept all events).

failure_threshold

integer

default:5

Auto-disable after this many consecutive failed executions.

Required range: 1 <= x <= 100

task_parameters

Task Parameters · object

Parameters merged into the task created when the trigger fires.

timezone

string

default:UTC

IANA timezone for cron evaluation (e.g. 'UTC', 'America/New_York').

validation_rules

Validation Rules · object

Per-channel validation rules (signature secrets, allowed senders, etc).

webhook_config

Webhook Config · object | null

Channel-specific configuration (bot tokens, signing keys, etc).

webhook_id

string | null

Public webhook path segment. Auto-generated if omitted for webhook triggers.

webhook_type

string

default:generic

Channel type: 'generic', 'telegram', 'slack', 'discord', etc.

Response

Successful Response

Response model for trigger data.

agent_id

string<uuid>

required

conditions

Conditions · object

required

consecutive_failures

integer

required

created_at

string

required

created_by

string

required

description

string

required

failure_threshold

integer

required

string<uuid>

required

is_active

boolean

required

name

string

required

task_parameters

Task Parameters · object

required

trigger_type

string

required

updated_at

string

required

allowed_methods

string[] | null

cron_expression

string | null

data_extractor

string | null

event_types

string[]

has_channel_credentials

boolean

default:false

last_execution_at

string | null

next_run_time

string | null

timezone

string | null

validation_rules

Validation Rules · object | null

webhook_config

Webhook Config · object | null

webhook_id

string | null

webhook_type

string | null

Create Trigger

curl --request POST \
  --url https://api.example.com/v1/triggers/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "allowed_methods": [
    "<string>"
  ],
  "channel_credentials": {},
  "conditions": {},
  "cron_expression": "<string>",
  "data_extractor": "<string>",
  "data_extractor_config": {},
  "description": "",
  "enabled": true,
  "event_types": [
    "<string>"
  ],
  "failure_threshold": 5,
  "task_parameters": {},
  "timezone": "UTC",
  "validation_rules": {},
  "webhook_config": {},
  "webhook_id": "<string>",
  "webhook_type": "generic"
}
'

import requests

url = "https://api.example.com/v1/triggers/"

payload = {
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "allowed_methods": ["<string>"],
    "channel_credentials": {},
    "conditions": {},
    "cron_expression": "<string>",
    "data_extractor": "<string>",
    "data_extractor_config": {},
    "description": "",
    "enabled": True,
    "event_types": ["<string>"],
    "failure_threshold": 5,
    "task_parameters": {},
    "timezone": "UTC",
    "validation_rules": {},
    "webhook_config": {},
    "webhook_id": "<string>",
    "webhook_type": "generic"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    allowed_methods: ['<string>'],
    channel_credentials: {},
    conditions: {},
    cron_expression: '<string>',
    data_extractor: '<string>',
    data_extractor_config: {},
    description: '',
    enabled: true,
    event_types: ['<string>'],
    failure_threshold: 5,
    task_parameters: {},
    timezone: 'UTC',
    validation_rules: {},
    webhook_config: {},
    webhook_id: '<string>',
    webhook_type: 'generic'
  })
};

fetch('https://api.example.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.example.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([
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'allowed_methods' => [
        '<string>'
    ],
    'channel_credentials' => [
        
    ],
    'conditions' => [
        
    ],
    'cron_expression' => '<string>',
    'data_extractor' => '<string>',
    'data_extractor_config' => [
        
    ],
    'description' => '',
    'enabled' => true,
    'event_types' => [
        '<string>'
    ],
    'failure_threshold' => 5,
    'task_parameters' => [
        
    ],
    'timezone' => 'UTC',
    'validation_rules' => [
        
    ],
    'webhook_config' => [
        
    ],
    'webhook_id' => '<string>',
    'webhook_type' => 'generic'
  ]),
  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/triggers/"

	payload := strings.NewReader("{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"allowed_methods\": [\n    \"<string>\"\n  ],\n  \"channel_credentials\": {},\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"data_extractor\": \"<string>\",\n  \"data_extractor_config\": {},\n  \"description\": \"\",\n  \"enabled\": true,\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"failure_threshold\": 5,\n  \"task_parameters\": {},\n  \"timezone\": \"UTC\",\n  \"validation_rules\": {},\n  \"webhook_config\": {},\n  \"webhook_id\": \"<string>\",\n  \"webhook_type\": \"generic\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.example.com/v1/triggers/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"allowed_methods\": [\n    \"<string>\"\n  ],\n  \"channel_credentials\": {},\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"data_extractor\": \"<string>\",\n  \"data_extractor_config\": {},\n  \"description\": \"\",\n  \"enabled\": true,\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"failure_threshold\": 5,\n  \"task_parameters\": {},\n  \"timezone\": \"UTC\",\n  \"validation_rules\": {},\n  \"webhook_config\": {},\n  \"webhook_id\": \"<string>\",\n  \"webhook_type\": \"generic\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.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["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"allowed_methods\": [\n    \"<string>\"\n  ],\n  \"channel_credentials\": {},\n  \"conditions\": {},\n  \"cron_expression\": \"<string>\",\n  \"data_extractor\": \"<string>\",\n  \"data_extractor_config\": {},\n  \"description\": \"\",\n  \"enabled\": true,\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"failure_threshold\": 5,\n  \"task_parameters\": {},\n  \"timezone\": \"UTC\",\n  \"validation_rules\": {},\n  \"webhook_config\": {},\n  \"webhook_id\": \"<string>\",\n  \"webhook_type\": \"generic\"\n}"

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

{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conditions": {},
  "consecutive_failures": 123,
  "created_at": "<string>",
  "created_by": "<string>",
  "description": "<string>",
  "failure_threshold": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "name": "<string>",
  "task_parameters": {},
  "trigger_type": "<string>",
  "updated_at": "<string>",
  "allowed_methods": [
    "<string>"
  ],
  "cron_expression": "<string>",
  "data_extractor": "<string>",
  "event_types": [
    "<string>"
  ],
  "has_channel_credentials": false,
  "last_execution_at": "<string>",
  "next_run_time": "<string>",
  "timezone": "<string>",
  "validation_rules": {},
  "webhook_config": {},
  "webhook_id": "<string>",
  "webhook_type": "<string>"
}

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

Start here

Concepts

Guides

Self-host

Reference

API Endpoints

Community

Create Trigger

Authorizations

Body

Response