YOyougile
Подписки на события

Получить список подписок

get/api-v2/webhooks

Request

  • Base URL
    https://api-docs.yougile.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

includeDeletedboolean

По умолчанию, если объект был отмечен как удаленный, то он не будет найден. Поставьте true, чтобы удаленные объекты возвращались.

Response

Все подписки

idstring required

ID объекта

deletedboolean

Если true, значит объект удален

urlstring required
eventstring required

Событие подписки. Подписаться можно только на события в компании. Подписаться на личные чаты не получится, потому что они не относятся к событиям в компании. Формат: <тип_объекта>-<событие>. Для объектов project,board,column,task,sticker,department,group_chat,chat_message, возможные события: created,deleted,restored,moved,renamed,updated. Для объектов user, возможные события: added, removed. Может использоваться javascript regexp как значение. Например, task-* - подписка на все события по задачам, или .* - подписка на все события.

disabledboolean

Если true, то вызываться не будет

lastSuccessnumber

Время последнего успешного вызова

failuresSinceLastSuccessnumber required

Количество неуспешных вызовов. Сбрасывается до 0 при любом успешном вызове

Example response

{
  "id": "4f6f0391-0f94-4d30-9b0e-99430a36d4fb",
  "url": "https://webhook.site/947c0ee4-fd8c-416c-9e1c-2b3cd5d78a8d",
  "event": "task-created",
  "disabled": true,
  "lastSuccess": 1655989112,
  "failuresSinceLastSuccess": 1655989112,
  "filters": [
    {
      "name": "location",
      "value": [
        "858c5d32-dd93-4d2b-9b9c-aa1ec7007c0c",
        "432c5d32-dd93-4d2b-9b9c-aa1ec7007c0c"
      ]
    },
    {
      "name": "title",
      "value": "^!"
    },
    {
      "name": "chat_message",
      "value": "^/bot "
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.