Update webhooks documentation

This commit is contained in:
Frederic Guillot
2016-07-23 19:21:32 -04:00
parent ca45b5592b
commit 8e6e335c9d
2 changed files with 401 additions and 244 deletions

View File

@@ -1,16 +1,10 @@
Web Hooks
=========
Webhooks
========
Webhooks служат для взаимодействия с внешними приложениями. Webhook посылает уведомление стороннему приложению о событиях, которые произошли в Канборд.
- Webhooks могут быть использованы для создания задач вызовом простого URL (Вы можете сделать это и при помощи API)
- Обращение к внешнему приложению может происходить автоматически, когда наступает какое-либо событие в Канборд (создана задача, обновлен комментарий и т.д.)
@@ -18,89 +12,36 @@ Webhooks служат для взаимодействия с внешними п
Как написать webhook приемник во внешнем приложении?[](#how-to-write-a-web-hook-receiver "Ссылка на этот заголовок")
---------------------------------------------------------------------------------------------------------------------
Все внутренние события в Канборде могут быть посланы во внешний URL.
- Webhook URL (url приемник внешнего приложения) может быть задан в **Настройки** -\> **Webhooks** -\> **Webhook URL**
- Когда в Канборде происходит событие, Канборд обращается к указанному URL автоматически
- Данные конвертируются в формат JSON и передаются с помощью POST HTTP запроса
- Webhook ключ передается в составе запроса в виде строкового параметра. Таким образом, вы можете проверить, что запрос на самом деле пришел из Канборда.
- **Созданный вами URL должен среагировать в течении 1 секунды**. Это желательно сделать потому, что запросы являются синхронными (ограничения языка PHP) и возможны тормоза в пользовательском интерфейсе, если скрипт будет слишком медленный!
### Список поддерживаемых событий[¶](#list-of-supported-events "Ссылка на этот заголовок")
- comment.create (комментарий.создать)
- comment.update (комментарий.обновить)
- file.create (файл.создать)
- task.move.project (задача.переместить.проект)
- task.move.column (задача.переместить.колонка)
- task.move.position (задача.переместить.место)
- task.move.swimlane (задача.переместить.дорожка)
- task.update (задача.обновить)
- task.create (задача.создать)
- task.close (задача.закрыть)
- task.open (задача.открыть)
- task.assignee\_change (задача.назначить\_изменить)
- subtask.update (подзадача.обновить)
- subtask.create (подзадача.создать)
- comment.create
- comment.update
- comment.delete
- file.create
- task.move.project
- task.move.column
- task.move.position
- task.move.swimlane
- task.update
- task.create
- task.close
- task.open
- task.assignee_change
- subtask.update
- subtask.create
- subtask.delete
- task_internal_link.create_update
- task_internal_link.delete