The wxrks Contentful connector sends entries from your Contentful spaces into wxrks for translation, and syncs the finished translations back once they're ready — one entry at a time, or in bulk across many entries at once.
💡 Who is this for? This guide is for the Account Admin who connects Contentful to wxrks, and the content editor in Contentful who sends entries for translation day to day.
1. Create a connection from wxrks
In wxrks, go to Integrations > Contentful. The Configs tab lists every Contentful connection already set up in this account; click Add Configuration to start a new one.
2. Create the configuration
The Create new Configuration screen walks through both halves of the setup on one page: first establishing wxrks's access to Contentful (below), then installing the wxrks app on the Contentful side (Section 3).
Fill in:
Name — a reference name for this configuration.
Space ID — your Contentful workspace's unique ID (see 2.1 below).
CMA Access Token — a personal access token for Contentful's Content Management API (see 2.2 below).
Click Create when both are filled in.
2.1. Space ID in Contentful
Click in Settings and General Settings, and click to copy the Space ID.
2.2. CMA Token in Contenful
Go to Settings and click on CMA tokens.
Click in Create personal access token
Choose a token name
Choose an expiration date if you wish
Click in Generate
Click to copy the CMA token and go back to wxrks.
3. Install the wxrks app on Contentful
Still on the wxrks configuration screen from Section 2, scroll down to the Install the wxrks APP on Contentful step, or click the button below directly. This installs the wxrks app inside your Contentful space, which is what shows the wxrks panel on an entry's sidebar and the wxrks app under Contentful's Apps tab used later in this guide. Click Install wxrks on Contentful.
Choose the Space and Environment in which you want to install this application and click Continue.
Click on Authorize Access to start the process of setting up this application.
Provide the API ID and Secret Key from your wxrks account, then click "Test Connection" to verify the validity of these credentials.
If you haven't created any API ID and Secret Key yet, go to your profile in wxrks, navigate to Security, and click on Generate to copy the access credentials. See Authenticating with the wxrks API for the full walkthrough.
⚠️ Warning: Generating a new key will invalidate the previous one, so remember to update the services using this key to ensure proper connectivity.
Copy the Connector Config UUID that you created in the "Create new configuration for this installation" section and paste it below. Then, select the workflows in which you wish to create projects in wxrks. And click Install to selected environments to finish the installation.
After installing the app, it's necessary to define which content models can utilize the app in the sidebar.
4. Create a Configuration Group (project settings)
A configuration group is what actually turns a Contentful entry into a wxrks project — it ties one of your Contentful configurations (Section 2) to a wxrks Organizational Unit and a contact person. In wxrks, go to Integrations > Contentful, switch to the Configuration Group tab, and click Add Configuration.
Name — a reference name for this configuration group.
Project Name Prefix — an optional custom prefix used in the name of every wxrks project this group creates (defaults to "Contentful").
Configs — the Contentful configuration(s) from Section 2 this group applies to.
Organizational Units — at least one Organizational Unit to create projects under. Make sure it has its source and target locales configured, or project creation will fail.
Contact Person — receives project notifications.
Click Create to finish.
5. Translation Request (Single Entry)
Navigate to the Content tab in Contentful and select an entry that you previously configured in the Content model installation in the "Installing the wxrks App" section.
On the right side of the sidebar, you'll find the wxrks Application. Click on "Create project on wxrks" to initiate your first project in wxrks directly from Contentful.
Select the Project Config that you created in the section "Creating a Configuration Group." Ensure that the workflows and target locales are correct, then click on "Send to wxrks".
If your project was successfully created on the wxrks side, you will see the status for each locale.
By clicking on "Fetch translations" you can retrieve the translations once they are completed in wxrks.
6. Translation Requests (Multiple Entries)
Navigate to the Apps tab in Contentful and click in wxrks app (or wxrks - Demo).
When you enter the wxrks app, you'll see a screen with two tabs: "Create Project" and "List Projects". The first tab is where you select the content to be sent for translation on wxrks. The second is for listing projects created on wxrks so you can track progress or pull translations in batches as needed.
6.1. Filters to Search Content
Utilize filters to search content efficiently. Search by text within entries, by Content types, by Tags and Created by me and seamlessly navigate between pages without losing the context of previously selected entries. Keep track of your selections with the "Total Selected" count.
6.2. Submit Content for Translation
When you've chosen the content you want to batch create in wxrks, click on the "Create project on wxrks" button. Next, select the necessary settings and assign a name to your project. Once you've finalized the settings, click "Send to wxrks" and wait until you see a pop-up confirming that the project has been successfully created.
7. Listing Current Projects and Pulling Translations
In the "List Projects" tab, you can monitor your projects created from Contentful. In this list, you can view the associated content, languages, and the progress of translations in wxrks.
By clicking the "Show contents" button, you'll be able to view the list of entries associated with the project. Additionally, clicking on the information icon in the "Target Locales" column will display the list of languages to which each entry will be translated.
After the project has been marked as delivered in wxrks, you can retrieve the translations by clicking on the "Fetch translations" button. You can also click on "More actions" to select the "Force" option, which will pull the translations into the current state of wxrks, regardless of whether they are completed or not.