Setting up the Contentstack connector

Step by step setup, from first contact to your first translation request. For Contentstack administrators.

Work through the shared steps, then the steps for the method you chose. You can add the second method later without redoing the shared steps.

Shared steps

1. Tell us your host

Send Translated the Contentstack Content Management API base URL that applies to your account.

2. Configure your languages

  1. Go to Settings > Languages.

  2. Click + New Language.

  3. Configure the language, selecting the specific variant where it matters.

  4. Click Add.

Send Translated the full list of source and target languages for every stack. Each stack can have a different list. The language marked Default is the source language. See Language codes.

3. Create the translation workflow

  1. Go to Settings > Workflows.

  2. Click + New Workflow.

  3. Name it, and add a description if you want one.

  4. Select the content types in scope.

  5. Configure the stages. Three must be consecutive: translation requested, translation in progress, translation ready. The second and third must be available as next stages from every other stage, and all users and roles must be allowed to move between them.

  6. Add any workflow superusers.

  7. Enable the workflow and click Save.

Send Translated a screenshot of the workflow whenever you create or change it.

4. Send us your stack API key

Found per stack under Settings > Stack > API Credentials > ApiKey.

5. Wait for confirmation

Translated configures your account before you go further. This matters for the app: installing it before your configuration exists makes authentication fail.

If you will request translations from workflow stages

Create a management token

Needed only if you will not install the Translated app.

  1. Log in with an admin account.

  2. Go to Settings > Tokens > Management Tokens.

  3. Click + Management Token and name it.

  4. Grant both read and write permissions.

  5. Set Expiry to Never.

  6. Click Generate Token, copy the token, and click Done.

The token cannot be viewed again once you close the dialog. Send it to Translated with the stack API key.

Create the webhook

  1. Go to Settings > Webhooks and click + New Webhook.

  2. Name it and set the URL to notify:

    • Sandbox: https://tos-connector-contentstack.sandbox.translated.com/v1/contentstack/intake

    • Production: https://tos-connectors-queues.translated.com/connectors/contentstack

  3. If a username and password are mandatory, enter dummy values. Otherwise select None as the authentication method.

  4. Add a custom header x-api-key with the API key Translated gives you.

  5. Add notification email addresses if you want them.

  6. Set the trigger so the webhook fires when an entry's workflow stage changes to the first of your three translation stages.

  7. Untick Send Concise Payload.

  8. Tick Enable Webhook and click Save.

Optional: extra service types

To request a service type other than your default, create a workflow stage named after your first stage, a hyphen, and the service type name. If your first stage is translation-request, the stage for the urgent service type is translation-request-urgent.

Contentstack caps stage names at 32 characters, so keep your prefix short.

If you will request translations from the app

Install the Translated app from the Contentstack marketplace, after Translated confirms your configuration is in place.

The app authenticates with OAuth 2.0, which is configured automatically during installation. There is no token to create and no webhook to set up.

Testing

Ask Translated to put you in sandbox mode. Sandbox returns machine translated content so you can check the round trip end to end without placing a real order. When you are satisfied, agree the service types and switch to production.