Вебхуки

Вебхуки повідомляють і допомагають вам отримувати інформацію про ключові події, що відбуваються у вашому проекті 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": {{language_code}}, "file_id": {{file_identifier}}, "file": {{file_name}} }

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

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

Приклад відповіді:

{ "event": "file.approved", "project": {{project_identifier}}, "project_id": {{project_id}}, "language": {{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}} }

Редагування або видалення вебхуків

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

Історія викликів

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