Versions Compared

Key

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

Webhooks instantly alert you upon workflow completion, allowing you to promptly download and use the translated file, saving time.

...

  • Project ID: Use placeholder: {{projectId}}

  • Document ID: Use placeholder: IDs: (From December 2024), please use {{documentIds}} (an array of documents). With Standard projects, a workflow may include more than 1 document.

    • The former placeholder {{documentId}} is still available but is superseded with a plural version to cater to multi-document workflows, see bullet point above.

  • Target Locale: Use placeholder: {{branchLocale}} - Preferred over {{targetLocale}}

With these properties you have all that is needed to download the file.

Configure webhooks

Enable webhooks in the project

Navigate to your (Codyt) project and go to the “Workflow & Suppliers” tab.

...

  1. Utilize the “Preview and test” link available on the configuration page for an initial check.

  2. For a real-world test, create a Codyt project, upload a document, and complete all jobs (for a target language) to trigger the webhook.

  3. Reopening and completing jobs once more will indeed reactivate the webhook.

Use webhook.site for your tests

The free online tool https://webhook.site/ instantly gives you a public URL that you can use as a test webhook endpoint. Whenever, the URL is called by Wordbee, the web page of webhook.site will show the call and all its parameters:

...