Webhooks

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.

Use Cases

You can add webhooks to build integrations with the services or with your backend. For example:

  • Set up a webhook to send notifications to the system you use
  • Pass information to the third-party services with the specific request requirements (for example, HTTP method, сontent type)
  • Create custom integrations with Crowdin Enterprise

Events

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

Adding Webhooks

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:

  • A name for the webhook (for example, “App Project Translated”)
  • The events to post to the URL. You can select either one event or a specific set of events
  • The URL where the callback should be sent
  • The request method, either GET or POST that indicates the desired action to be performed for a given resource
  • The content type for the POST request method (multipart/form-data, application/json, or application/x-www-form-urlencoded)

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.

Add Webhook

When adding a webhook, you can test how your application will react on that call.

Test Webhook

Custom Payloads

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.

Custom Payload

Edit or Delete Webhooks

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.

Manage Webhooks

Activities

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.

Webhooks Activities

Was this article helpful?