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

Создать подписку

Создает подписку на события в компании

post/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

Request body

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-* - подписка на все события по задачам, или .* - подписка на все события.

Example request

{
  "url": "https://webhook.site/947c0ee4-fd8c-416c-9e1c-2b3cd5d78a8d",
  "event": "task-created",
  "filters": [
    {
      "name": "location",
      "value": [
        "858c5d32-dd93-4d2b-9b9c-aa1ec7007c0c",
        "432c5d32-dd93-4d2b-9b9c-aa1ec7007c0c"
      ]
    },
    {
      "name": "title",
      "value": "^!"
    },
    {
      "name": "chat_message",
      "value": "^/bot "
    }
  ]
}

Response

Подписка создана

idstring required

ID объекта

Example response

{
  "id": "4f6f0391-0f94-4d30-9b0e-99430a36d4fb"
}

Changes

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