Вебхуки (Webhooks)

Вебхуки — это обратные вызовы от сервиса СУП к системе партнера. Они позволяют получать автоматические уведомления о следующих событиях:
- статусы изменения настроек (лимитов) карт
- статусы заказов пластиковых или виртуальных карт
- статусы пополнения карт.

Основное описание

- Вебхук — это POST-запрос от сервиса СУП к системе партнера на предоставленный URL.
- Цель: снижение нагрузки на систему партнера и сервис.
- Включается опционально (по запросу партнера).

Формат вебхука

{
  "data": {
    "replenishmentId": "019812ff-a4a0-7ac2-8e5d-f63e81a6143f",
    "status": "PART_SUCCESS"
  },
  "operation": "REPLEMISHMENT"
}

Поля вебхука

Параметр	Тип	Описание
data	dict	Словарь, содержащий данные по сотрудникам
replenishmentId	uuid	Уникальный идентификатор запроса. Название параметра зависит от вида запроса
status	string	Статусы для: -изменения настроек (лимитов) карт, -заказов пластиковых или виртуальных карт, -пополнения карт
operation	string	Название вида запроса

Возможные значения operation

operation	Описание
REPLEMISHMENT	Запрос на пополнение
ORDER_CARDS	Запрос на заказ карт
SET_LIMITS_CARDS	Запрос на изменение настроек карт

Статусы запросов

Пополнение (REPLEMISHMENT)

status	Описание
SUCCESS	Запрос полностью успешно обработан
PART_SUCCESS	Запрос обработан частично (Есть отклоненные на пополнение карты)
DECLINE	запрос отклонен. Ни одна карта не пополнена

Заказ карт (ORDER_CARDS)

status	Описание
CARDS_SENT	Карты отправлены (для пластиковых)
DONE	Заказ выполнен
CANCELED_MANAGER_BEFORE_PRECESSING	Отменен менеджером до обработки
CANCELED_MANAGER	Заказ отменен менеджером во время обработки (для пластиковых)

Изменение настроек (SET_LIMITS_CARDS)

status	Описание
SUCCESS	Запрос полностью успешно обработан
PART_SUCCESS	Запрос обработан частично (Есть отклоненные на изменение настроек карты)
DECLINE	Запрос отклонен. Ни одна карта не изменена

В случае недоступности сервиса партнера, сервис СУП делает повторные отправки уведомлений.