Webhooks notify and help you collect information about the key events that happen in your Crowdin Enterprise project, like completed translations or proofreading. After you configure a webhook for the project, Crowdin Enterprise will start sending a POST or GET requests with data to the webhook URL via HTTP.
You can configure webhooks to listen for the following events: project fully translated or reviewed, file fully translated or reviewed, translation added, updated, deleted, approved or unapproved.
Only admins and group/project managers can register a webhook.
You can add webhooks to build integrations with the services or with your backend. For example:
You can configure webhooks for the following types of events:
File fully translated
File fully reviewed
Project fully translated
Project fully reviewed
Exported translation updated – final translation of a string is updated
Suggested translation added – a string in the project is translated
Suggested translation updated – a translation for a string in the project is updated
Suggested translation deleted – one of the translations is deleted
Suggested translation approved – a translation for a string is approved
Suggested translation unapproved – approval for a previously added translation is removed
To configure webhooks in Crowdin Enterprise, go to the Project Page and select Resources > Webhooks on the left.
You will need to provide the following information to register a webhook:
Optionally, you can add special headers to your webhook. They can be used for additional security, as an authorization method, and more. For example, if you add headers, your webhook endpoint can check them to ensure that information is coming from Crowdin Enterprise.
When adding a webhook, you can test how your application will react on that call.
Each event type in Crowdin Enterprise has a specific payload format with the relevant event information. You can customize the webhook payload to add and organize the elements the way your system requires.
To check the possible variables for the event, click the info icon in the right upper corner on the Payload section.
You can access the list of all existing webhooks within a specific project. You will be able to edit or delete webhooks right from the list of webhooks displayed.
After the events are triggered you will be able to check webhook calls history of each webhook separately. Use the filter to check all or only unsuccessful webhook notifications.