---
title: "Создать подписку"
method: POST
path: "/api-v2/webhooks"
tags: ["Подписки на события"]
---

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

`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)
- URL: `https://api-docs.yougile.com/api-v2/webhooks`
- Auth: HTTP bearer

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

## Request body

- CreateWebhookDto
  - `url` string, required
  - `event` string, required: Событие подписки. Подписаться можно только на события в компании. Подписаться на личные чаты не получится, потому что они не относятся к событиям в компании. Формат: `<тип_объекта>-<событие>`. Для объектов `project,board,column,task,sticker,department,group_chat,chat_message`, возможные события: `created,deleted,restored,moved,renamed,updated`. Для объектов `user`, возможные события: `added`, `removed`. Может использоваться javascript regexp как значение. Например, `task-*` - подписка на все события по задачам, или `.*` - подписка на все события.
  - `filters` WebhookFilters[], required: Дополнительные фильтры для вебхука
    - `name` unknown[], required: Название фильтра. Возможные значения: location, title, chat_message
      - unknown
    - `value` string[], required: Значение фильтра. Для location - UUID или массив UUID, для title - regexp, для chat_message - regexp

## Response `201`

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

- WithIdDto
  - `id` string, required: ID объекта

---

[API](https://skmtc.dev/yougile/apis/yougile-rest-api-v2-0.md) - [All operations](https://skmtc.dev/yougile/apis/yougile-rest-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/yougile/apis/yougile-rest-api-v2-0/revisions/9452cba35716?raw)