...
Alternatively, you might choose to periodically check for finished workflows, a less efficient method. For this, see the API method: projects/{pid}/workflows/list/delivered
Configure webhooks
Enable webhooks in the project
Navigate to your (Codyt) project and go to the “Workflow & Suppliers” tab.
...
Tick Select the options to automatically create generate translated files and to trigger activate webhooks:
...
Configure the webhook
Next, you need to register the URL that is called when a workflow completes. The URL must point to your web service that handles the event.Login as administrator and click Settings. Then select the Developer API Webhooks in will call upon workflow completion. Log in as an administrator, click on "Settings," and then choose "Developer API Webhooks" on the page.
...
To set up a new webhook:
Click on "Add new webhook
...
" at the top right and
...
select "Document workflow -
...
Finished" from the dropdown menu.
...
Add the URL. You can include This prepares the new webhook for configuration.
Enter the URL, incorporating URL parameters with placeholders such as like the document ID and branch language as needed.
Customize the HTTP BODY, if needednecessary, to include specific data for your service.
Add HTTP HEADERS, such as those required for Basic Authentication, to ensure secure communication.
Add Conditions Implement “Conditions” to restrict limit the webhook to a specific project (apply particular project by applying a condition to {{projectReference}}).
Test webhook
To test your webhook , use effectively:
Utilize the “Preview and test” link
...
available on the configuration page for an initial check.
For
...
a real-world test, create a Codyt project, upload a
...
document, and
...
complete all jobs
...
(for a target language) to trigger the webhook.
Reopening and completing jobs
...
once more will indeed reactivate the webhook.