Create trigger

Creates a new trigger in a phase of the flow.

A trigger defines an event to watch for (type) and one or more actions (actions[]) to run when the associated conditions are met. The available event types cover data being saved (save-phase-fields, save-opinion, save-approval, save-card-responsible, save-card-label), card creation or movement (create-card, move-card), engine execution (execute-credit-engine, execute-decision-engine), and the completion of asynchronous processes (finalized-document, finalized-auto-document, finalized-query-agrisk, finalized-auto-query-agrisk).

Each action in actions[] has its own type (set-labels, move-card, sse-event, start-conversation, or set-assignee) and its own list of conditions (conditions[]). Within conditions[], each block works as OR against the others; within a block, the rule[] array works as AND. The conditions array must always be sent explicitly, even empty ([]), when the action should run unconditionally.

On the move-card action, the parameter that indicates the destination phase is params.phaseId. There is no targetPhaseId parameter, and the mode parameter is not accepted on this action — sending either one is rejected by the API.

On the set-labels action, each item in params.labels[] must have a color identical to one of the options already registered in the flow's labelOptions; colors outside that list are not accepted.

The API does not prevent creating two triggers of the same type on the same phase, but when both fire for the same event the outcome is non-deterministic — in the case of set-labels, for example, the last write wins. We recommend always listing the triggers already configured on the phase (GET /v1/triggers/phases/{phaseId}) before creating a new one, and updating the existing trigger instead of duplicating it.

We recommend creating triggers last when setting up a flow, after phases, fields, engines, opinions, and approval workflows are already in place, since conditions typically reference those resources.

curl --location '/v1/triggers' \ --header 'Content-Type: application/json' \ --data '{ "flowId": "string", "phaseId": "string", "type": "create-card", "actions": [ { "type": "set-labels", "conditions": [ { "rule": [ { "path": "string", "reference": "string", "condition": "string", "target": null } ] } ], "params": { "mode": "overwrite", "labels": [ { "label": "string", "color": "string" } ], "phaseId": "string", "message": "string", "assignee": { "userId": "string", "userName": "string", "userEmail": "string" } } } ] }'

Create trigger

Requisição

Respostas