Веб-хуки

Вебхуки уведомляют и помогают вам получать информацию о ключевых событиях, происходящих в вашем проекте Crowdin, таких как выполненные переводы или утверждение. Эти пользовательские обратные вызовы позволяют Crowdin открывать ранее установленные URL-адреса через HTTP.

Только владельцы проектов и руководители проектов могут зарегистрировать вебхук.

Вы можете настроить вебхуки на прослушивание следующих событий: проект полностью переведен или проверен, файл полностью переведен или проверен, перевод добавлен, обновлен, удален, одобрен или не одобрен.

Общий обзор

Представьте следующую информацию для создания вебхука в Crowdin:

• Имя вебхука (например, “Приложение переведено”).
• URL, на который должен быть отправлен обратный вызов.
• Метод запроса GET или POST, указывающий желаемое действие, которое должно быть выполнено для данного ресурса.
• Тип содержимого (* multipart / form-data, application / json, application / x-www-form-urlencoded * доступно только для метода запроса POST).
• События для публикации через URL. Вы можете выбрать либо одно событие, либо определенный набор событий.

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

Чтобы настроить вебхуки в Crowdin, выполните следующие действия:

1. Перейдите на закладку API в пункте настройки проекта.
2. Прокрутите до раздела Вебхуки и нажмите Добавить Вебхук.
3. Укажите название веб-хука и URL для получения запросов.
4. Выберите удобный способ запроса GET или POST. Если вы выберете POST – выберите тип содержимого для этого метода запроса.
5. Выберите одно событие или набор событий для получения уведомлений.
6. Нажмите ** Тест ** чтобы проверить, какой ответ вы получите.
7. Нажмите Добавить чтобы сохранить изменения.

События

Вы можете настроить вебхуки для следующих событий:

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

Вебхук будет запущен, когда любой из ваших файлов проекта будет полностью переведен.

Пример ответа:

{
    "event": "file.translated",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language_id": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}}
}

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

Вебхук будет запущен, когда любой из ваших файлов проекта будет полностью проверен.

Пример ответа:

{
    "event": "file.approved",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language_id": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}}
}

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

Вебхук будет запущен, когда все строки проекта будут переведены.

Пример ответа:

{
    "event": "project.translated",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}}
}

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

Вебхук будет запущен, когда все строки проекта будут проверены.

Пример ответа:

{
    "event": "project.approved",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}}
}

Экспортированный перевод обновлен

Вебхук будет отправлен при обновлении окончательного перевода строки.

Пример ответа:

{
    "event": "translation.updated",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "source_string_id": {{source_string_identifier}},
    "old_translation_id": {{old_translation_identifier}},
    "new_translation_id": {{new_translation_identifier}},
    "user": {{user_name}},
    "user_id" {{user_identifier}},
    "file_id": {{file_identifier}},
    "file": {{file_name}}
}

Добавлено предложение варианта перевода

Вебхук будет запущен, когда строка из проекта будет переведена.

Пример ответа:

{
    "event": "suggestion.added",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}},
    "source_string_id": {{source_string_identifier}},
    "translation_id": {{translation_identifier}},
    "user": {{user_name}},
    "user_id": {{user_identifier}}
}

Предлагаемый перевод обновлен

Вебхук будет запущен, когда ранее добавленный перевод для строки из проекта обновлен.

Пример ответа:

{
    "event": "suggestion.updated",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}},
    "source_string_id": {{source_string_identifier}},
    "translation_id": {{translation_identifier}},
    "user": {{user_name}},
    "user_id": {{user_identifier}}
}

Предложенный перевод удален

Вебхук будет запущен, когда ранее добавленный перевод для строки удален из проекта.

Пример ответа:

{
    "event": "suggestion.deleted",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}},
    "source_string_id": {{source_string_identifier}},
    "translation_id": {{translation_identifier}},
    "user": {{user_name}},
    "user_id": {{user_identifier}}
}

Предлагаемый перевод утверждён

Вебхук будет запущен, когда ранее добавленный перевод для строки будет утверждён.

Пример ответа:

{
    "event": "suggestion.approved",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}},
    "source_string_id": {{source_string_identifier}},
    "translation_id": {{translation_identifier}},
    "user": {{user_name}},
    "user_id": {{user_identifier}}
}

Одобрение предложенного перевода отменено

Вебхук будет запущен, когда ранее добавленный и одобренный перевод для строки пересмотрен и одобрение отменено.

Пример ответа:

{
    "event": "suggestion.disapproved",
    "project": {{project_identifier}},
    "project_id": {{project_id}},
    "language": {{language_code}},
    "file_id": {{file_identifier}},
    "file": {{file_name}},
    "source_string_id": {{source_string_identifier}},
    "translation_id": {{translation_identifier}},
    "user": {{user_name}},
    "user_id": {{user_identifier}}
}

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

Список существующих вебхуков будет показан в разделе «Вебхуки». Вы можете редактировать или удалять вебхуки прямо из отображаемого списка.

История вызовов

История вызовов всех добавленных вебхуков будет доступна в том же разделе. Используйте фильтр для проверки всех или только неудачных уведомлений от вебхуков.