Skip to main content
PUT
Update event.

Authorizations

Authorization
string
header
required

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

Path Parameters

eventId
string
required

Body

application/json
version
number
required

Version.

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"

custom
boolean

Whether this is a user-triggerable custom event.

name
string

Provide name of trigger.

category
string

Category.

desc
string

Description.

metadata
object | null

Replacement 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.

targetType
enum<string>

Optional normalized execution target type. Must be sent together with targetId when changing the target.

Available options:
JOB_TEMPLATE,
AGENT,
PLATFORM_OPERATION
targetId
string

Optional normalized execution target id aligned with targetType.

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. Send null to clear.

type
string

Event routing name without an implicit prefix.

Response

OK.

Last modified on September 5, 2026