# Webhooks

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

Для настройки перейдите в раздел [Настройки портала => Webhooks](https://portal.pro.rent/subscription/portal-settings/webhooks), укажите ссылку и типы сущностей, по которым отправлять уведомления:

* Подписка
* Сотрудники
* Объекты
* Контрагенты
* Договоры
* Счета и акты
* Деньги
* Обратная связь

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

{% code title="" %}

```http
POST {Ваш URL}
```

{% endcode %}

{% code title="HTTP-заголовки" %}

```http
User-Agent: Pro.rent/{версия}
X-Prorent-Type: {тип сущности}
X-Prorent-Action: {действие}
```

{% endcode %}

{% code title="Body" %}

```typescript
{
    type: string, // Тип сущности
    action: string, // Действие
    data: ApiСущность,
    referer: string, // Значение HTTP-заголовка "Referer" исходного запроса (если заголовок был)
    operationId: string // Значение HTTP-заголовка "X-Operation-Id" исходного запроса (если заголовок был)
}
```

{% endcode %}

В поле `data` запроса передается сущность из [swagger-схемы](https://portal.pro.rent/api) согласно типу. Поля `referer` и `operationId` можно использовать для фильтрации изменений.

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

{% hint style="warning" %}
На обработку webhook система дает 10 секунд, за которые необходимо вернуть HTTP код 2xx.
{% endhint %}

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

* `ApiSubscription` – аккаунт.
* `ApiEmployee` – сотрудник.
* `ApiBuilding` – объект.
* `ApiContractor` – контрагент.
* `ApiContract` – договор.
* `ApiDocument` – счёт, акт, претензия, акт РСО или справка РСО.
* `ApiPayment` – платеж.
* `ApiFeedback` – запрос обратной связи.

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

* `Create`
* `Update`
* `Delete`


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pro.rent/d/api/webhooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.