guides

Project and task statuses

What each project and task status means, which changes the API accepts, and how they map to the statuses of other platforms.

Project statuses

You change a project's status with Change Project Status. A change outside this table is refused with Unsupported transition.

FromTo
DRAFTPENDING, CANCELLED, DELETED, CONTINUOUS
PENDINGDRAFT, APPROVED, CANCELLED, DELETED
APPROVEDDRAFT, PENDING, DELIVERED, CANCELLED, DELETED
DELIVEREDDRAFT, INVOICED, PARTIALLY_INVOICED, NOT_INVOICED
PARTIALLY_INVOICEDINVOICED
NOT_INVOICEDDELIVERED
CONTINUOUSDRAFT, CANCELLED, DELETED
CANCELLEDDRAFT
INVOICED, DELETEDnone

Some changes have extra conditions:

Reverting a cancelled project

Cancelling closes the project's open tasks: a task with an assignee and confirmed segments is delivered as it stands, every other one is cancelled, and their work units are closed. Reverting the project to DRAFT does not reopen them, and no payable changes. When the project is approved again, tasks are created only for the work units that have none, such as files or steps added while it was back in DRAFT. A file whose tasks were cancelled gets no new task.

Replacing a source file

An approved project that needs a new source file goes back to DRAFT, gets the file through Preview Source Update and Apply Source Update, and is approved again. Translations of unchanged segments are kept, and so are the assignees unless you send keepAssignees: false.

An approved project that needs one more workflow step does not have to leave APPROVED: Add Workflow Steps with allowApproved=true adds steps after the last existing step. The project keeps its status, no status webhook is sent, the first step is not translated again, and the new steps' tasks are created once their work units are ingested. A step that would go between existing steps is refused, and so is a DELIVERED project. The project's costs do not change: when the new step is billed, add the line with Add Costs Manually.

Task statuses

A task is one workflow step of one work unit.

StatusMeaning
PENDINGNobody is assigned.
PENDING_ACCEPTANCEOffered to a vendor, who must accept or decline it.
ASSIGNEDAssigned and open for work.
PENDING_CONFIRMATIONDelivered with the hours worked, waiting for the project manager to confirm the delivery.
DELIVEREDDelivered.
INVOICED, PAID, NOT_INVOICEDDelivered, and settled by invoicing and payables.
SKIPPEDThe step was skipped; it has no assignee.
CANCELLEDThe step was cancelled.
SCHEDULED, EXPIREDOlder statuses that wxrks no longer sets on its own. Treat them as open.

DELIVERED, INVOICED, PAID and NOT_INVOICED count as completed: the bulk actions on translations (Clear Translations, Confirm All) skip these steps unless the org unit lets delivered tasks be edited.

Changing a task's status

Task Status moves a task to another status. It is refused for an INVOICED or PAID task and when the task is already in that status. Besides the status, some targets do more:

TargetWhat else happens
ASSIGNEDA delivered work unit is reopened for work.
PENDINGThe work unit goes back in progress. The assignee is kept: use Revoke Task Assignment to remove it.
DELIVEREDThe task is delivered as from the editor, and its payable calculated. From NOT_INVOICED it only goes back to DELIVERED.
SKIPPEDThe step is skipped, and its assignee and rates are removed.
CANCELLEDThe step is cancelled in the editor and its work unit closed. Not for split tasks.
Any otherOnly the status changes.

Assignment

Choosing the email template per send

An account has one template per email type, and can keep named variants of the assignment emails, for example an auditor email.

The assignment email's type depends on the task:

TypeSent when
TASK_PENDING_ACCEPTANCEThe task waits for the vendor to accept it.
TASK_ASSIGNED_READYThe task has no previous step, or the previous step is closed.
TASK_ASSIGNED_NOT_READYThe previous step is still in progress.
TASK_READYThe previous step is delivered.
TASK_SKIPPEDThe previous step is a skipped review.
  1. Save a variant with Save Notification Template, giving its variant name (1 to 64 letters, digits, - or _). Save it for each type it may be sent as: an auditor step usually starts after the previous step is delivered, so TASK_READY at least. List Notification Templates with includeVariants=true shows them, and Reset Notification Template with variant removes one.
  2. Send it with template=<name>:
  3. on Assign Task to User: the assignment sends the variant instead of the default email, so the assignee gets one email;
  4. on Notify Task Assignee, to send the assignment email again.

To send only the emails you choose, turn vendor email notifications off in the org unit: they cover the emails wxrks sends on its own, such as the ready email once the previous step is delivered, while template on an assignment and Notify Task Assignee still send.

A name the account has no variant of for the type the task sends answers 400: the assignment does not happen and nothing is sent. Without template, the account's default template is sent, as before. Bulk Assign Tasks to User and includeRelatedTasks always send the default template.

Coming from Phrase

Phrase job statuswxrks
NEWPENDING
EMAILEDPENDING_ACCEPTANCE
ACCEPTEDASSIGNED, after Accept Task Assignment
DECLINEDNo status of its own: Decline Task Assignment revokes the assignment and the task is PENDING again
DELIVEREDPENDING_CONFIRMATION while the delivery waits for confirmation, then DELIVERED
COMPLETEDDELIVERED, INVOICED, PAID or NOT_INVOICED
CANCELLEDCANCELLED, or SKIPPED for a step that was skipped