Update a trigger
Authentication
Basic authentication of the form Basic <base64(username:password)>.
Path parameters
The trigger’s unique identifier (triggers._id), a UUIDv7.
Request
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.
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.
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.
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.
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.
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.
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.
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.
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
Legacy field, kept only to support workflows written for the old input shape. Absent for an API on-demand trigger.
The POST body schema stored after the edit. Present only for an API on-demand Trigger that has one.
The form the Trigger references after the edit. Present only for a manual on-demand Trigger that has one.
The form values stored after the edit. Present only for a manual on-demand Trigger.
The route name stored after the edit, exactly as typed. Present only for an API on-demand Trigger.
The id of the JST stored after the edit. Present only for an API on-demand or an event Trigger that has one.