Contentful (TMS)

Content is machine translated from English by Phrase Language AI.

Available for

  • Business and Enterprise plans

Get in touch with Sales for licensing questions.

Available for

  • Enterprise plan (Legacy)

Get in touch with Sales for licensing questions.


For information about Contentful integration in Phrase Strings, refer to Contentful (Strings).

Contentful provides a headless content management infrastructure to create, manage and distribute content to any platform or device.


The connector does not support the translation of JSON objects.

Supported Localization Methods

Contentful supports multiple localization methods. See Contentful documentation for their detailed description.

Entry-Level Localization

Use Contentful (Entry-Level) connector.

The entry-level connector only works with content types that have localized reference fields (e.g., a reference field called Localized that is enabled for localization).

Field-Level Localization

Use Contentful (Field-Level) connector.

The field-level connector only works with content types that have a translatable field (e.g., either Text or Rich Text field with enabled localization) and Media Assets. If the connector is configured to import referenced entries, it traverses the entire hierarchy of nested content and imports all translatable fields for translation. If the reference field is enabled for localization, it imports the reference that match the project's source language.

Use Cases

There are a number of use cases for the connector:

  • Project managers can add files directly to projects from an online repository. Content is searchable by Entry ID.

  • Set up the submitter portal so Submitters can add files to requests directly from the online repository. Content is searchable by Entry ID.

  • Use automated project creation (APC) to have new projects automatically created when a change in the content size is detected for monitored documents or a folder.

    • Selected files are imported the very first time APC runs.

Use cases for the application:

  • Content editors can directly submit an entry for localization from within Contentful. This allows content editors or managers having full control over the localization flow and having status updates on-the-fly when viewing an entry.

    Once the entry has been finalized:

    • Select the desired target languages for localization.

    • Submit only the entry with the selected languages to Phrase TMS or use the Field selection tab to select fields.

    • Based on APC settings, jobs are automatically created from the submitted content. During APC runs, only entries in the submitted status are picked up for job creation.

    • Once jobs from a submitted entry are created, the status changes to in progress. When the translations are pushed back to Contentful, the status changes to completed.

    • Previously translated entries can be re-submitted after changes in original copy.

  • Content editors can use the Phrase TMS home screen to:

    • Submit entries in bulk.

    • Specify individual target languages while bulk submitting.

    • Have an overview of active translation jobs.

Contentful Settings

When working with Phrase TMS application:

  1. Download the Phrase TMS application from the marketplace.

  2. Install the application to the current active space and select the content models where the application requires installing.

  3. Enter the Phrase TMS Auth token acquired when creating the connector within Phrase TMS.

  4. Click Install.

Optional - Launch App

If using workflow support via the Launch App by Contentful, follow these steps:

  1. Install Contentful's Launch application to one or more spaces.


    Only one workflow can be created per space. If different approaches for content types is required within one Contentful space, contact the dedicated Customer Success Manager.

  2. Set up the required localization workflow.

  3. Select content type or types that follow the described workflow.

If workflows in a connector are set, Automated Project Creation (APC) will automatically create new projects when a change in the workflow steps is detected for monitored articles or content types.

Phrase TMS Settings


If accessing from a custom domain (ex., open an incognito browser window and log in via or to apply the authentication required for the creation or saving of the connector. After saving, the connector can be accessed via the custom domain.

  1. From the Settings Setup_gear.png page, scroll down to the Integrations section.

  2. Click on Connectors.

    The Connectors page opens.

  3. Click New.

    The Create page opens.

  4. Select the Phrase Contentful App checkbox if using the connector with the app.

    • Contentful App token

      Generate an application token to be entered into the Phrase TMS Contentful application.


    Once a token is added to the application configuration in Contentful, it cannot be changed from within Contentful. To change the token, revoke it in the connector configuration and generate a new token to create a new connector to Phrase TMS.

  5. Configure language agnostic settings.

    • Select space

      Select a space to configure a source language that is supposed to overwrite the default language of the Contentful space.

    • Select environment

      Select the environment of the set space.

    • Source language

      Select a source language to overwrite the Contentful default language. The connector will then pull in content from the language set up in the connector configuration.


      If Contentful has EN-US as the default language, but DE-DE is required as localization source language for a particular space or content model, the space (remote folder) content can be only pulled in from DE-DE (instead of EN-US) by configuration.


    Not applicable when using the application.

  6. Select how to process nested content through Entry import mode. Content can use a reference field to reference other content allowing the creating a hierarchy of entities.


    Not applicable when using the application.

    • Contentful (Entry-Level)

      The entry-level connector automatically traverses the entire hierarchy of nested content.

    • Contentful (Field-Level)

      Select how the field-level connector should import nested content.

      • Selected entry only

        • Content that is explicitly selected when adding from the repository is imported.

        • Changes detected by APC are imported for translation.

      • Import referenced entries

        • The connector traverses the entire hierarchy of nested content and imports all translatable fields for translation.

  7. Create a comma-separated list in Omit translatable fields to omit fields that are checked for Enable localization of this field from import to Phrase TMS. Use the following structure: contentTypeID:fieldID.

    • Select Leave omitted fields empty if the listed fields should be left empty. This setting will be applied to all listed entries.

    • Select Copy source to target if the listed fields should contain source values. This setting will be applied to all listed entries.

  8. Select Use fallback language if data is missing for a particular field in the source language.

    Select a Source language fallback from the dropdown list if required. This language locale will be used in the case of missing data.


    There is no relationship between the Contentful fallback language and this setting.

  9. If logging of debug information is requested by technical support team, select Log debug information.

  10. Click Connect to Contentful.

    A checkmark will appear in the connector setup if the connection was successful. A red exclamation point will appear if it wasn't. Hover over the icon to see additional details.

  11. Contentful (Entry-Level) only:

    Set the Source language.


    This language should match the Default locale of the Contentful space that's configured in Contentful's Locales settings.

  12. Click Save.

    The connector is added to the list on the Connectors page.

  13. Optionally, edit the connector to select Contentful workflows.

    • Translate articles from:

      The connector monitors articles in the selected stage (e.g. Translate). The author can apply this label to articles when ready for translation.

    Upon import from Contentful:

    • Set source articles to

      The connector advances the workflow to the selected stage (e.g. Translation in Progress) when the source articles are downloaded.

    Upon export to Contentful:

    • Set source articles to

      The connector sets the workflow stage of the source articles to the selected stage (e.g. Translations Completed) when the translation is exported.


    The workflow support will be discontinued by Contentful on June 1, 2023. Continue using it at your own risk.

Was this article helpful?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.