Назначение webhook
Webhook нужен там, где внешний сервис должен сообщать bartys о событии без ручного запроса со стороны приложения.
Что требуется описать
- endpoint;
- метод запроса;
- пример payload;
- схему валидации подписи;
- политику повторной доставки.
Структура payload
Обязательные поля
Перечислите минимальный набор полей, без которых событие не может быть обработано.
Опциональные поля
Опишите, как система ведёт себя, если этих полей нет.
Повторная доставка
Если источник шлёт одно и то же событие повторно, обработка должна быть идемпотентной.
Идемпотентность
Используйте уникальный event_id или эквивалентный идентификатор из источника.
Логи и аудит
Сохраняйте в логах только технические детали, без секретов и персональных данных.