Skip to main content
POST
Create a task in a revision

Authorizations

Authorization
string
header
required

A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.

Path Parameters

workflow_id
integer
required

ID of the workflow the revision belongs to.

Example:

123

revision_id
integer
required

ID of the revision the task belongs to.

Example:

789

Body

application/json

Task to create

Request body for creating a task. Only source is required. An omitted name defaults to the action's name, but no input gets a default value: send every input the action requires in input_parameters.

source
TaskSource · object
required

The catalog action a task is bound to.

Example:
conditions
Conditions · object

Conditions controlling whether the action runs; omit when the action has none.

continue_on_status
enum<string>

Which outcome of this task lets the tasks that depend on it run: succeeded (only when it succeeds, its execution state completed) or succeeded_skipped (when it succeeds or is skipped).

Available options:
succeeded,
succeeded_skipped
Example:

"succeeded"

event_trigger
EventTrigger · object

Configuration of an orchestrator orchestrator/event_trigger ("Wait for trigger") action, which pauses the workflow until the event selected in its input_parameters.event arrives. Not allowed on other actions.

input_parameters
object

Inputs passed to the action, keyed by its parameter names, following the action's input_json_schema. To link a parameter to another task's output, set that parameter object's source to the task's id (UUID) and type to task; slugs are not resolved here.

loop
Loop · object

Loop configuration controlling how the action iterates. The action runs once per item; its input_parameters and conditions reference the current item with {{ @item }} or {{ @item.field.path }}. To use the iterations' outputs downstream, add an orchestrator collect_loop_outputs/call action that depends on the looped action, with input_parameters {"source": {"source": "<looped action slug>", "type": "task", "value": "{{ @raw }}"}}. Its output is a JSON array of the iterations' outputs, referenced like any other action's output.

name
string

Name of the task. Defaults to the action's name.

Example:

"Create job"

note
string

Free-text note about the task.

Example:

"Creates the job for the incoming project."

retry_strategy
RetryStrategy · object

Retry strategy configuration.

Response

Created

The identifier of the newly created task.

id
string<uuid>
required

Unique identifier of the created task.

Example:

"8fa72263-21ab-4f76-83ba-50c6b4378c49"