С помощью метода можно подключить отправку вебхуков на переданный URL. В параметрах можно указать, какие типы сообщений передавать в хуке:

Чаты по объявлениям пользователя:

• [offersMessagesIncoming] — только входящие сообщения по объявлениям пользователя
• [offersMessagesIncoming, offersMessagesLkOutgoing] — все сообщения по объявлениям пользователя, отправленные не через API
• [offersMessagesIncoming, offersMessagesLkOutgoing, offersMessagesApiOutgoing] — все сообщения по объявлениям пользователя

Чаты по чужим объектам, на которые откликнулся пользователь:

• [inquiryOffersMessagesIncoming] — только входящие сообщения в чатах по чужим объектам
• [inquiryOffersMessagesIncoming, inquiryOffersMessagesLkOutgoing] — все сообщения в чатах по чужим объектам, отправленные не через API
• [inquiryOffersMessagesIncoming, inquiryOffersMessagesLkOutgoing, inquiryOffersMessagesApiOutgoing] — все сообщения в чатах по чужим объектам

Чаты по новостройкам:

• [newbuildingMessagesIncoming] — только входящие сообщения по новостройкам
• [newbuildingMessagesIncoming, newbuildingMessagesLkOutgoing] — все сообщения по новостройкам, отправленные не через API
• [newbuildingMessagesIncoming, newbuildingMessagesLkOutgoing, newbuildingMessagesApiOutgoing] — все сообщения по новостройкам

Чаты с другими пользователями не по конкретному объекту:

• [agentMessagesIncoming] — только входящие сообщения в чатах с другими пользователями
• [agentMessagesIncoming, agentMessagesLkOutgoing] — все сообщения в чатах с другими пользователями, отправленные не через API
• [agentMessagesIncoming, agentMessagesLkOutgoing, agentMessagesApiOutgoing] — все сообщения в чатах с другими пользователями

Прочие типы:

• [systemMessages] — системные сообщения от Циан и модерации;
• [chatsReadability] — вебхук о прочитанности чата;

Например:

• [offersMessagesIncoming] — только входящие сообщения по объявлениям пользователя
• [offersMessagesIncoming, systemMessages] — только входящие по объявлениям пользователя и системные сообщения
• [offersMessagesIncoming, offersMessagesLkOutgoing, systemMessages] — все сообщения по объявлениям пользователя, отправленные не через API, а также системные сообщения от Циана и модерации

<b>Важно!</b>

• В вебхуке будут приходить все новые сообщения всех выбранных типов — это может быть одно или несколько сообщений.
• Если сообщения не удаётся доставить на URL в течение 72 часов, этот URL будет автоматически отключен.
• В ответе метода указаны модели вебхуков, которые будут отправляться на указанные URL.

Пример:

curl -X POST -H 'Authorization: Bearer <ACCESS TOKEN>' https://public-api.cian.ru/v3/subscribe-webhooks --header 'Content-Type: application/json' --data-raw '{"url": "https://example.com", "webhookTypes": ["offersMessagesIncoming", "agentMessagesIncoming"]}'