Skip to navigation

Update a trigger

Edits a trigger, such as its name, description, resource action, manual form and inputs, POST body schema, endpoint route name, or event source, topic, and schema. Can also enable or disable the trigger set that owns it.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

triggerIdstringRequired

The trigger’s unique identifier (triggers._id), a UUIDv7.

Request

body
namestringOptional
The Trigger's new name, shared by every Trigger under the same owning set. Must contain at least one character that is not whitespace.
descriptionstringOptional
enabledbooleanOptional
Master switch that determines whether the trigger and any services associated with it can fire. Omit to leave unchanged.
resourceActionobjectOptional
Replaces the Trigger's whole resource action setting. Omit to leave it unchanged. Only for a Trigger of a resource model.
bodySchemaobjectOptional

Replaces the stored POST body schema of an API on-demand Trigger, whole. Omit to leave it unchanged; it can’t be cleared. It is stored as given, and a body that does not match it is rejected when the endpoint is called. A schema that cannot be used (an unknown keyword, a $ref to nothing, an unknown $schema or format, or $async) is rejected with a 400 and the reason. Rejected for any other kind of Trigger.

legacyWrapperbooleanOptional

Legacy field, kept only to support workflows written for the old input shape: before July 2023, Operations Manager passed form values to the workflow inside one variable named formData. Omit to leave unchanged. Turning it on is refused unless the trigger’s asset is a workflow, and supplying it for an API on-demand trigger is refused.

sourcestringOptional
Points an event Trigger at another event source, which the platform must declare. Omit to keep the current one. Rejected for any other kind of Trigger.
topicstringOptional
Points an event Trigger at another topic, which the platform must declare under the source. Omit to keep the current one. 'jobStart' and 'jobComplete' are rejected. Rejected for any other kind of Trigger.
formIdstringOptional

Points a manual on-demand Trigger, and its service, at another form. Omit to leave it unchanged; to remove the form, use clearForm. The new form is looked up and the stored form values are cleaned against it: a form that cannot be loaded refuses the edit. Resending the stored value changes nothing and makes no lookup. Rejected for an API on-demand Trigger or a manual one with no service, and for a schedule or event Trigger. The platform removes a null or an empty string from a call before it is validated, so either one is the same as leaving the field out.

inputsobjectOptional

Replaces the form values stored on a manual on-demand Trigger, whole; an empty object is a value. Omit to leave them unchanged. They are cleaned against the Trigger’s form, as when a Trigger is created, so values the form no longer has are dropped, and a form that cannot be loaded refuses the edit, an empty object included. A Trigger with no form stores them as sent. Resending the stored value changes nothing and makes no lookup. Rejected in the same cases as formId. The platform removes a null from a call before it is validated, so it is the same as leaving the field out.

clearFormbooleanOptional

Removes the form from a manual on-demand Trigger and from its service; false, or leaving it out, changes nothing. No form is looked up. It is a flag because the platform removes a null from a call before it is validated, so a null formId could never arrive. Rejected together with formId, and in the same cases as formId.

routeNamestringOptional

Gives an API on-demand Trigger another route name. Letters of either case, digits, underscores and hyphens; case-sensitive and stored exactly as typed, so the same letters in another case are another route. Omit to leave it unchanged. Rejected when another API Trigger, enabled or disabled, already has the new route name. A set that is being enabled is checked the same way, even when its route name is not edited; an edit that changes neither is not checked. Rejected for a manual on-demand Trigger and for a schedule or event Trigger.

jststringOptional

Replaces the JST of an API on-demand Trigger or an event Trigger, by id (an event Trigger stores it as jstId); it is not looked up. Omit to leave it unchanged; to remove it, use clearJst. Rejected for a manual on-demand Trigger and for a schedule Trigger.

schemaobjectOptional

Replaces the payload schema an event Trigger filters received events by, whole. Omit to leave it unchanged; it can’t be removed. An empty object is a schema that accepts every payload. It is stored as given and not tested against any event; it is read from the stored Trigger when an event arrives. A schema that cannot be used (an unknown keyword, a $ref to nothing, an unknown $schema or format, or $async) is rejected with a 400 and the reason. Rejected for any other kind of Trigger.

clearJstbooleanOptional

Removes the JST of an API on-demand Trigger or an event Trigger; false, or leaving it out, changes nothing, and so does a Trigger that has no JST. It is a flag because the platform removes a null from a call before it is validated, so a null jst could never arrive. Rejected together with jst, and in the same cases as jst.

Response

result
triggerIdstring
namestring
descriptionstring
enabledboolean
resourceActionobjectOptional
legacyWrapperbooleanOptional

Legacy field, kept only to support workflows written for the old input shape. Absent for an API on-demand trigger.

bodySchemaobjectOptional

The POST body schema stored after the edit. Present only for an API on-demand Trigger that has one.

sourcestringOptional
The event source stored after the edit. Present only for an event Trigger.
topicstringOptional
The event topic stored after the edit. Present only for an event Trigger.
formIdstringOptional

The form the Trigger references after the edit. Present only for a manual on-demand Trigger that has one.

inputsobjectOptional

The form values stored after the edit. Present only for a manual on-demand Trigger.

routeNamestringOptional

The route name stored after the edit, exactly as typed. Present only for an API on-demand Trigger.

jststringOptional

The id of the JST stored after the edit. Present only for an API on-demand or an event Trigger that has one.

schemaobjectOptional
The payload schema stored after the edit. Present only for an event Trigger that has one.

Errors

500
Internal Server Error