Tobto.shopДовідка

Вебхуки

Вебхук — це підключення, через яке магазин сам повідомляє вашу систему (CRM, склад, будь-який сервіс), коли щось відбувається: нове замовлення, оплата, відправлення, зміна товару чи залишку, новий покупець. Так ваша система дізнається про події без постійних запитів до магазину.

Як створити вебхук

  1. Відкрийте «Налаштування → Webhooks» і натисніть «Новий webhook».
  2. У полі «Куди надсилати» вкажіть адресу (https) вашого сервера. У підключення немає назви, воно впізнається за адресою, тож робіть її промовистою.
  3. У полі «Про які події повідомляти» оберіть хоча б одну подію. Список читається з реєстру подій платформи: підписатися на подію, яку ніхто не публікує, не вийде.
  4. Збережіть. Секретний ключ для підпису згенерується автоматично й покажеться один раз — скопіюйте його одразу.
  5. Натисніть «Тест», щоб надіслати пробну подію й перевірити, що ваш сервер відповідає.

Як це працює

  1. Коли подія стається, магазин надсилає на вашу адресу POST-запит із даними.
  2. Ваш сервер відповідає кодом 2xx — доставку вважають успішною.
  3. Запит підписаний секретним ключем: у заголовках X-Signature (HMAC SHA-256 від рядка «час.тіло запиту») і X-Signature-Timestamp. Перевіряйте підпис, щоб приймати лише справжні події. Підпис, старший за 5 хвилин, слід відхиляти.

Повторні спроби

Якщо ваш сервер не відповів, магазин пробує ще — через 1, 2, 4, 8 і 16 хвилин, разом до п'яти спроб. Після цього конкретну доставку позначено як остаточно невдалу, але саме підключення не вимикається: наступні події йтимуть далі. У блоці «Останні доставки» видно історію; кнопка «Повторити» надсилає доставку знову.

Як керувати підключеннями

  • Вкладки «Усі», «Активні», «З проблемами»; стани «Активний», «Призупинений», «Відкликаний».
  • «Призупинити» і «Увімкнути» зупиняють та відновлюють надсилання.
  • «Оновити секрет» створює новий ключ підпису; оновіть його й на вашому сервері.
  • Відкликане підключення лишається в списку, але подій більше не отримує; повернути його не можна.
  • Зверху видно «Активні», «Доставок за добу», «Успішність» і «Чекають повтору».

Важливо

  • Адреса має бути https і публічною: локальні, внутрішні й приватні адреси магазин не викликає.
  • Відповідайте швидко кодом 2xx, а важку обробку виконуйте після відповіді.
  • Для KeyCRM і SalesDrive вебхуки не потрібні, вони підключаються окремо, див. CRM. Binotel, Bitrix24 та інші сервіси підключаються саме через вебхуки; на сторінці «BAS / 1С і CRM» є посилання «Налаштувати вебхуки».
  • Для доступу сторонніх програм до даних магазину використовуються ключі доступу в «Налаштування → API-ключі».

Див. також