Webhooks
Вы можете получать программные оповещения о событиях, произошедших в Pro.rent, посредством отправки уведомлений.
Для настройки перейдите в раздел Настройки портала => Webhooks, укажите ссылку и типы сущностей, по которым отправлять уведомления:
Подписка
Сотрудники
Объекты
Контрагенты
Договоры
Счета и акты
Деньги
Обратная связь
При создании, изменении или удалении выбранной сущности, система отправит запрос:
POST {Ваш URL}
User-Agent: Pro.rent/{версия}
X-Prorent-Type: {тип сущности}
X-Prorent-Action: {действие}
{
type: string, // Тип сущности
action: string, // Действие
data: ApiСущность,
referer: string, // Значение HTTP-заголовка "Referer" исходного запроса (если заголовок был)
operationId: string // Значение HTTP-заголовка "X-Operation-Id" исходного запроса (если заголовок был)
}
В поле data
запроса передается сущность из swagger-схемы согласно типу. Поля referer
и operationId
можно использовать для фильтрации изменений.
В ответ система ожидает успешный HTTP код 2xx
. Система будет пытаться доставить webhook максимум 10 раз.
На обработку webhook система дает 10 секунд, за которые необходимо вернуть HTTP код 2xx.
Типы сущностей
ApiSubscription
– аккаунт.ApiEmployee
– сотрудник.ApiBuilding
– объект.ApiContractor
– контрагент.ApiContract
– договор.ApiDocument
– счёт, акт, претензия, акт РСО или справка РСО.ApiPayment
– платеж.ApiFeedback
– запрос обратной связи.
Типы действий
Create
Update
Delete
Last updated