Skip to main content
POST
Create events.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
custom
boolean
required

true: user-triggerable custom event; false: native platform event, replayable only from history.

name
string
required

Provide name of trigger.

targetType
enum<string>
required

Normalized execution target type used by runtime dispatch.

Available options:
JOB_TEMPLATE,
AGENT,
PLATFORM_OPERATION
targetId
string
required

Normalized execution target id aligned with targetType.

active
boolean
required

Active.

type
string
required

Event routing name without an implicit prefix. Native types use the platform event catalogue; custom types use a user-defined name.

input
object

Runtime input for Job targets, exposed through api.input("templateInputs"). Defaults to {}. Override is shallow; Deep Override recursively merges objects. Automation keys take precedence; arrays and null replace whole values. Does not change the event message, Job execution policy, concurrency or retry settings.

Example:
inputMode
enum<string>
default:override

override: shallow overlay onto Job templateInputs; deep_override: recursively overlay objects, replacing arrays and retaining null as a value; automation keys win in both modes; replace: replace all Job templateInputs, including clearing them with {}. Defaults to override.

Available options:
override,
deep_override,
replace
Example:

"override"

category
string

Category.

desc
string

Description.

metadata
object | null

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

targetVersion
number

Optional reserved target version metadata. Ignored for AGENT targets, which always execute the current Agent definition.

targetConfig
object

Optional normalized target configuration payload reserved for future target-specific execution settings.

filter
object

Optional FilterNode-compatible event message filter evaluated against { type, message } before scheduling the target.

Response

Job scheduled.

Last modified on September 5, 2026