Webhooks

Вы можете получать программные оповещения о событиях, произошедших в pro.rent, посредством отправки уведомлений.

Для настройки перейдите в раздел Настройки портала => Webhooks, укажите ссылку и типы сущностей, по которым отправлять уведомления:

• Подписка

• Сотрудники

• Объекты

• Контрагенты

• Договоры

• Счета и акты

• Деньги

• Обратная связь

При создании, изменении или удалении выбранной сущности, система отправит запрос:

POST {Ваш URL}

HTTP-заголовки
User-Agent: pro.rent
X-Prorent-Type: {тип сущности}
X-Prorent-Action: {действие}

Body
{
    type: "{тип сущности}",
    action: "{действие}",
    data: {api-сущность},
    referer: "Значение HTTP-заголовка 'Referer' исходного запроса (если заголовок был)",
    operationId: "Значение HTTP-заголовка 'X-Operation-Id' исходного запроса (если заголовок был)"
}

В поле data запроса передается сущность из swagger-схемы согласно типу. Поля referer и operationId можно использовать для фильтрации изменений.

В ответ система ожидает успешный HTTP код 2xx. Система будет пытаться доставить webhook максимум 10 раз.

Типы сущностей

• Subscription (подписка)

• Employee (сотрудник)

• Building (объект)

• Contractor (контрагент)

• Contract (договор)

• Document (счет или акт)

• Payment (платеж)

• Feedback (запрос обратной связи)

Типы действий

• Create

• Update

• Delete