Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Project Setup

We advise setting up a distinct Codyt project for each Content Management System (CMS) you wish to integrate. However, if your specific scenario warrants it, linking multiple systems to a single project is also feasible.

Key project configurations include:

  • The API supports both Standard (starting in December 2024) and Codyt projects.

  • Initialize your workflow on the "Workflow & Suppliers" page.

    • Enable the option "Automatically create and save translated file upon workflow completion" to ensure that deliverables are immediately available for download upon completion.

  • Setup webhooks for real-time notifications upon the completion of a workflow and the availability of the file for download.

    • Activate the "Trigger webhook upon workflow completion" setting.

    • Define the webhook endpoint and parameters, see: Use Workflow Webhooks

    • Note: In scenarios where webhooks are not feasible, periodically check for completed workflows at regular intervals, such as hourly, by accessing projects/{pid}/workflows/list/completed

  • Configure document formats, also known as file filters, as outlined in the following section.

...