О системе
Тарифы
Блог
Портал
Search…
Главная
FAQ
Возможности
Первичная настройка
Публичный сайт
Надежность
Стоимость и закрывающие документы
Коробочная версия
Подробнее о функциях
Интеграция с 1С
Шаблоны документов
Коммуналка
API
Доступ по API
Webhooks
Формирование номера договора
События публичного сайта
Перечисления
Powered By
GitBook
Webhooks
Вы можете получать программные оповещения о событиях, произошедших в pro.rent, посредством отправки уведомлений.
Для настройки перейдите в раздел
Настройки портала => Webhooks
, укажите ссылку и типы сущностей, по которым отправлять уведомления:
Подписка
Сотрудники
Объекты
Контрагенты
Договоры
Счета и акты
Деньги
Обратная связь
При создании, изменении или удалении выбранной сущности, система отправит запрос:
1
POST {Ваш URL}
Copied!
HTTP-заголовки
1
User-Agent
:
pro.rent
2
X-Prorent-Type
:
{тип сущности}
3
X-Prorent-Action
:
{действие}
Copied!
Body
1
{
type
:
"{тип сущности}"
,
2
action
:
"{действие}"
,
3
data
:
{
api
-
сущность
},
4
referer
:
"Значение HTTP-заголовка 'Referer' исходного запроса (если заголовок был)"
,
5
operationId
:
"Значение HTTP-заголовка 'X-Operation-Id' исходного запроса (если заголовок был)"
6
}
Copied!
В поле
data
запроса передается сущность из
swagger-схемы
согласно типу. Поля
referer
и
operationId
можно использовать для фильтрации изменений.
В ответ система ожидает успешный HTTP код
2xx
. Система будет пытаться доставить webhook максимум 10 раз.
На обработку webhook система дает 10 секунд, за которые необходимо вернуть HTTP код 2xx.
Типы сущностей
Subscription (подписка)
Employee (сотрудник)
Building (объект)
Contractor (контрагент)
Contract (договор)
Document (счет или акт)
Payment (платеж)
Feedback (запрос обратной связи)
Типы действий
Create
Update
Delete
API - Previous
Доступ по API
Next - API
Формирование номера договора
Last modified
1yr ago
Copy link
Contents
Типы сущностей
Типы действий