1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
Webhooks
========
Webhooks служат для взаимодействия с внешними приложениями. Webhook посылает уведомление стороннему приложению о событиях, которые произошли в Канборд.
- Webhooks могут быть использованы для создания задач вызовом простого URL (Вы можете сделать это и при помощи API)
- Обращение к внешнему приложению может происходить автоматически, когда наступает какое-либо событие в Канборд (создана задача, обновлен комментарий и т.д.)
Как написать 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
- 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
### Пример HTTP запроса[¶](#example-of-http-request "Ссылка на этот заголовок")
POST https://your_webhook_url/?token=WEBHOOK_TOKEN_HERE
User-Agent: Kanboard Webhook
Content-Type: application/json
Connection: close
{
"event_name": "task.move.column",
"event_data": {
"task_id": "1",
"project_id": "1",
"position": 1,
"column_id": "1",
"swimlane_id": "0",
"src_column_id": "2",
"dst_column_id": "1",
"date_moved": "1431991532",
"recurrence_status": "0",
"recurrence_trigger": "0"
}
}
Функциональная часть всех событий имеет следующий формат:
{
"event_name": "model.event_name",
"event_data": {
"key1": "value1",
"key2": "value2",
...
}
}
Значения `event_data`{.docutils .literal} могут быть неупорядочены в событиях.
### Пример функциональной части события[¶](#examples-of-event-payloads "Ссылка на этот заголовок")
Создание задачи:
{
"event_name": "task.create",
"event_data": {
"title": "Demo",
"description": "",
"project_id": "1",
"owner_id": "1",
"category_id": 0,
"swimlane_id": 0,
"column_id": "2",
"color_id": "yellow",
"score": 0,
"time_estimated": 0,
"date_due": 0,
"creator_id": 1,
"date_creation": 1431991532,
"date_modification": 1431991532,
"date_moved": 1431991532,
"position": 1,
"task_id": 1
}
}
Изменение задачи:
{
"event_name": "task.update",
"event_data": {
"id": "1",
"title": "Demo",
"description": "",
"date_creation": "1431991532",
"color_id": "yellow",
"project_id": "1",
"column_id": "1",
"owner_id": "1",
"position": "1",
"is_active": "1",
"date_completed": null,
"score": "0",
"date_due": "0",
"category_id": "2",
"creator_id": "1",
"date_modification": 1431991603,
"reference": "",
"date_started": 1431993600,
"time_spent": 0,
"time_estimated": 0,
"swimlane_id": "0",
"date_moved": "1431991572",
"recurrence_status": "0",
"recurrence_trigger": "0",
"recurrence_factor": "0",
"recurrence_timeframe": "0",
"recurrence_basedate": "0",
"recurrence_parent": null,
"recurrence_child": null,
"task_id": "1",
"changes": {
"category_id": "2"
}
}
}
События изменеия задачи имеют поле `changes`{.docutils .literal}, которое содержит обновленные значения.
Перемещение задачи в другую колонку:
{
"event_name": "task.move.column",
"event_data": {
"task_id": "1",
"project_id": "1",
"position": 1,
"column_id": "1",
"swimlane_id": "0",
"src_column_id": "2",
"dst_column_id": "1",
"date_moved": "1431991532",
"recurrence_status": "0",
"recurrence_trigger": "0"
}
}
Перемещение задачи в другое место:
{
"event_name": "task.move.position",
"event_data": {
"task_id": "2",
"project_id": "1",
"position": 1,
"column_id": "1",
"swimlane_id": "0",
"src_column_id": "1",
"dst_column_id": "1",
"date_moved": "1431996905",
"recurrence_status": "0",
"recurrence_trigger": "0"
}
}
Создание комментария:
{
"event_name": "comment.create",
"event_data": {
"id": 1,
"task_id": "1",
"user_id": "1",
"comment": "test",
"date_creation": 1431991615
}
}
Изменение комментария:
{
"event_name": "comment.update",
"event_data": {
"id": "1",
"task_id": "1",
"user_id": "1",
"comment": "test edit"
}
}
Создание подзадачи:
{
"event_name": "subtask.create",
"event_data": {
"id": 3,
"task_id": "1",
"title": "Test",
"user_id": "1",
"time_estimated": "2",
"position": 3
}
}
Изменение подзадачи:
{
"event_name": "subtask.update",
"event_data": {
"id": "1",
"status": 1,
"task_id": "1"
}
}
Загрузка файла:
{
"event_name": "file.create",
"event_data": {
"task_id": "1",
"name": "test.png"
}
}
Создан снимок экрана:
{
"event_name": "file.create",
"event_data": {
"task_id": "2",
"name": "Screenshot taken May 19, 2015 at 10:56 AM"
}
}
[Русская документация Kanboard](http://kanboard.ru/doc/)
|
