Skip to content
Blackbird docs

XTM

View on Github

XTM Cloud is a translation management system. Features include the creation of projects and uploading files to these projects in order to translate them.

Before setting up

Before you can connect you need to make sure that:

  • You have an XTM Cloud instance with API access enabled.

Connecting

  1. Navigate to apps and search for XTM. If you cannot find XTM then click Add App in the top right corner, select XTM and add the app to your Blackbird environment.
  2. Click Add Connection.
  3. Name your connection for future reference e.g. ‘My XTM’.
  4. For client fill in your XTM Company name, also marked client in the XTM documentation.
  5. For User ID fill in your numeric XTM user ID. Note: This is not your username. A known way to retrieve this user ID is to log into your XTM portal, hover on your avatar in the top right corner and right click “open image in new tab”. Then in the URL of this page you will find your user ID.*
  6. Fill in your XTM user password.
  7. Finally fill in the base URL of your XTM instance. F.e. https://xtm.mycompany.com
  8. Click Connect.

* Do you know a better way to retrieve the User ID? Let us know!

connecting

Actions

Projects

  • List projects
  • Get project
  • Create project
  • Create project from template
  • Clone project
  • Update project
  • Add project target languages
  • Delete project target languages
  • Reanalyze project
  • Delete project
  • Get project estimates
  • Get project metrics

LQA

  • Search LQA reports Define the criteria to fetch the LQA reports you need. Optional parameters include:
    • Date from
    • Date to
    • Target languages
    • LQA type

Files

  • Download source files
  • Download source files as ZIP
  • Download project file
  • Download all project files
  • Download translated files
  • Upload source file
  • Upload translation file. This action utilizes /files/translations/{fileId}/status endpoint to check the status of the newly uploaded translation file. The action will wait for the translation to be processed and return the status of the translation file along with the File ID and the Project ID.
  • Generate files

Translation memories

  • Generate TM file
  • Download TM file

Customers

  • List customers
  • Create customer
  • Get customer
  • Update customer
  • Delete customer

Events

  • On analysis finished
  • On workflow transition
  • On job finished
  • On project created
  • On project accepted
  • On project finished
  • On invoice status changed
  • On projects created (polling)
  • On projects updated (polling)
  • On projects finished (polling)
  • On project status changed (polling)

Missing features

The current implementation covers the basic actions. However, in the future we can also support:

  • Project analytics
  • Custom fields
  • Jobs
  • External users

Let us know if you’re interested!

Feedback

Feedback to our implementation of XTM is always very welcome. Reach out to us using the established channels or create an issue.