Веб-хуки

Вебхуки уведомляют и помогают вам получать информацию о ключевых событиях, происходящих в вашем проекте Crowdin, таких как выполненные переводы или утверждение. After you configure a webhook for the project, Crowdin Enterprise will start sending POST or GET requests with data to the webhook URL via HTTP.

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.

События

You can configure webhooks for the following types of events:

  • Файл полностью переведен

  • Файл полностью проверен

  • Проект полностью переведен

  • Проект полностью проверен

  • Exported translation updated – final translation of a string is updated

  • Source string added

  • Source string updated

  • Source string deleted

  • 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 disapproved – approval for a previously added translation is removed

  • Task added

  • Task status changed

  • Task deleted

Добавление вебхуков

To configure webhooks in Crowdin Enterprise, open your project and go to Integrations > Webhooks on the left panel. Click Create to start configuring your new webhook.

You will need to provide the following information to register a webhook:

  • The webhook name (for example, “New translation added”).
  • События для публикации через URL. Вы можете выбрать либо одно событие, либо определенный набор событий.
  • URL, на который должен быть отправлен обратный вызов.
  • The request method that indicates the desired action to be performed for a given resource (use either GET or POST).
  • The content type for the POST request method (multipart/form-data, application/json, or application/x-www-form-urlencoded).
  • For the application/json content type, you can select Batch webhooks to merge multiple events into a single request.

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 to that call.

Test Webhook

Depending on your approach to webhooks management, you might need to add dedicated Crowdin Enterprise IP addresses to your firewall to allow Crowdin Enterprise to open the pre-configured webhook URLs.

Read more about IP Addresses.

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 event’s possible variables, hover over the Info icon in the Payload section’s right upper corner.

Custom Payload

Sending Webhooks to Slack

With the help of Crowdin Enterprise webhooks, you can send the notifications about pre-configured event types directly to a specific Slack channel.

To configure the webhooks’ sending to Slack, you’d need to create a simple Slack app. Read more about Sending messages to Slack using Incoming Webhooks.

As soon as you created and configured your Slack app, you’ll have a Webhook URL that should be used for the Webhooks configuration in your Crowdin Enterprise project.

Редактирование или удаление вебхуков

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 review the activity of each webhook separately. Use the filter to review all or only unsuccessful webhook notifications.

Webhooks Activities

Alternatively, you can review the full list of sent webhooks in the Webhooks Log. Filter webhook notifications by result (Any or Unsuccessful), event types, or name.

Webhooks Log

Нужна помощь

Need help working with Webhooks or have any questions? Contact Support Team.

Была ли эта статья полезной?