Requesting and tracking Contentstack translations

How to request a translation, follow its progress, cancel it, and fix the common problems. For anyone using the connector day to day.

Request from a workflow stage

With the master language active, move the entry to the first of your three translation stages. The entry's content type must be in scope for the workflow.

By default the connector requests every language enabled on the stack, with the master language as source, and includes referenced entries if reference depth is enabled on your account.

Add a comment when you change the stage to set options. Patterns use double curly braces and can be combined in one comment.

Pattern

What it does

{{locale:CODE}}

Request a specific target language. Repeat for several. Codes must match those configured in Contentstack

{{tos_instructions:TEXT}}

Instructions shown to the translators

{{tos_purchase_order:VALUE}}

Purchase order for this request

{{tos_cost_center:VALUE}}

Cost centre for this request

{{tos_autopublish:true}}

Publish the target entry automatically once the translation is delivered

{{tos_labels:LABEL,LABEL}}

Up to 50 labels, 50 characters each. Human translation only

{{tos_tag:KEY|VALUE}}

Up to 10 pairs, one pattern per pair. A repeated key keeps the last value. Keys accept letters, numbers, underscore and hyphen. 50 characters each. Human translation only

{{tos_mt_style:STYLE}}

faithful (default), creative, or fluid. Machine translation only

{{tos_mt_context:SENTENCE;SENTENCE}}

Up to 10 context sentences. Machine translation only

Example, human translation:

{{locale:de-de}} {{locale:fr-fr}} {{tos_instructions:Maintain formal tone}} {{tos_purchase_order:PO-2024-001}} {{tos_autopublish:true}} {{tos_labels:label1,label2}}

Example, machine translation:

{{locale:de-de}} {{locale:fr-fr}} {{tos_autopublish:true}} {{tos_mt_style:creative}} {{tos_mt_context:use third person; use a formal tone}}

To request a service type other than your default, move the entry to the dedicated stage named for that service type instead. See Setting up the connector.

Request from the app

  1. Open the entry and select the Translated app in the sidebar.

  2. Choose the target languages.

  3. Choose the service type, or keep your default.

  4. Optionally add translator instructions, a purchase order, or a cost centre.

  5. Optionally add labels and tags for human translation, or a style and context sentences for machine translation.

  6. Optionally ask for the translations to be published automatically on delivery.

  7. Optionally select the specific fields to translate.

  8. Submit.

App requests translate only the entry you submitted. Referenced entries are not followed.

Following progress

While translation is in progress the entry sits in your second workflow stage, and a comment carries the information you need to track the request.

In the app, each requested language shows as In Progress, Ready, or Unsupported.

When every field in every target language is complete, the entry moves to your translation ready stage. If you asked for automatic publishing, the entry is published to your configured environments at that point.

Cancelling

Requests still in the queue can be cancelled on the TranslationOS dashboards. Every request belonging to the entry's fields has to be cancelled for the entry to return to a clean state. Once the cancellation goes through, the entry moves to your third workflow stage and can be submitted again from the app.

For anything already in production, contact your project manager.

Troubleshooting

Nothing happened when I moved the entry. Check that the entry's content type is in scope for the workflow, that you moved it with the master language active, and that the webhook is enabled and carries the x-api-key header.

Some languages came back and others did not. The entry only moves to your translation ready stage when every field in every language is complete, so a partly delivered entry is normal mid-flight. If one language never starts, its code may not have passed validation. See Language codes.

A field was not translated. Check its type in the table on the overview, then check whether it is marked Non-localizable in your content model. Both are by design.

I am getting authentication errors in the app. The app's token lasts one hour. Close and reopen the app, or refresh the page, then submit again.

I get an HTTP 502. The connector is very likely down. Contact Translated and it will be restarted.

FAQ

What happens if I edit an entry while it is being translated? The translation is still delivered. If you sent a newer version of the same field for translation in the meantime, a later delivery of the earlier request can overwrite the newer translation. Avoid resubmitting a field while a request for it is still open.

How do I translate into only some languages? From a workflow stage, add {{locale:}} patterns to the stage comment. From the app, select them in the UI.

Where do I find my tracking IDs? Content ID is the entry ID and field path. Order ID is the entry ID. Order group ID is the entry title, or the main entry title where referenced entries are involved. See Tracking IDs.