Webhooks

Webhooks notify and help you collect information about the key events that happen in your Crowdin project, like completed translations or proofreading. After you configure a webhook for the project, Crowdin will start sending POST or GET requests with data to the webhook URL via HTTP.

Only owners and 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.

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

  • 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

Adding Webhooks

To configure webhooks in Crowdin, open your project and go to Settings > API & Webhooks tab and select Webhooks on the left. Click Add Webhook to start configuring your new webhook.

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

  • The webhook name (for example, “App Project Translated”).
  • The URL where the callback should be sent.
  • 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.
  • The events to post to the URL. You can select either one event or a specific set of events.

When adding a webhook, click Test to see how your application will react to that call.

Add Webhook

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

Read more about IP Addresses.

Sending Webhooks to Slack

With the help of Crowdin 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 project.

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

Zugriffsverlauf

In the Calls History section you can see the list of calls of all webhooks that were added in the project. Use the filter to view all or only unsuccessful webhook notifications.

Zugriffsverlauf

Seeking Assistance

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

War dieser Artikel hilfreich?