Вебхуки в API FoodSoul: CRM самостійно повідомляє вашим сервісам про нові події

Тепер FoodSoul самостійно надсилає сповіщення вашим системам, коли в CRM щось відбувається. Наприклад, надійшло нове замовлення, клієнт оплатив або повернув гроші, зареєструвався новий гість. Достатньо один раз вказати адресу свого сервісу, і дані одразу надходитимуть в облікову систему, ваш бот, іншу CRM чи аналітику.

Про які події можна отримувати сповіщення

1. Нове замовлення з повною карткою. Знадобиться для облікової системи, кухні та аналітики.
2. Зміна статусу замовлення. Підійде для бота, який повідомляє клієнта про замовлення, і для кол-центру.
3. Зміна статусу оплати, включаючи повернення. Потрібна бухгалтерії та фінансовому обліку.
4. Новий клієнт і зміна його даних. Для зовнішньої CRM і сервісів розсилок.
5. Нарахування, списання та згорання бонусів. Для програми лояльності та комунікацій із гостями.
6. Новий відгук. Для керівника та служби якості.
7. Призначення кур'єра. Для логістики та сповіщень клієнту.
8. Зміна стоп-листа. Для сайту, кухні та майданчиків, на яких ви продаєте.
9. Філія зупинила або відновила прийом замовлень. Для операційного контролю та керівництва мережі.

Ви самі обираєте, які події отримувати. Можна підключити лише потрібні, наприклад “нове замовлення” та “оплата”. Не знайшли потрібної події? Напишіть нам — ми з радістю додамо її.

Як підключити

1. Увімкніть вебхуки для потрібної філії — ключ підпису створиться автоматично.
2. Оберіть події, про які хочете отримувати сповіщення.
3. Вкажіть адресу вашого сервісу, на яку FoodSoul буде надсилати дані. Підійде лише адреса з HTTPS.
4. Додайте ключ підпису в сервіс, який приймає сповіщення, і налаштуйте перевірку підпису. Якщо при створенні вебхуків ви вказали різні адреси, додайте ключ у кожен сервіс.
5. Переконайтеся, що сервіс підтверджує отримання сповіщення протягом 10 секунд, інакше FoodSoul надішле його повторно.

6. Налаштуйте перевірку на повтори: одне й те саме сповіщення може прийти кілька разів. У всіх повторів однаковий ID (заголовок X-Webhook-ID). Нехай ваш сервіс запам’ятовує ID оброблених сповіщень і пропускає повтори — так одна оплата не проведеться двічі.

    

Безпека: навіщо потрібен ключ підпису
 

FoodSoul підписує кожне сповіщення за допомогою ключа підпису — набору символів, який є лише у вас і у нас. За цим підписом ваша система перевіряє, що сповіщення надійшло від FoodSoul і по дорозі його ніхто не змінив.
 

Надіслати запит на адресу вашого сервісу може хто завгодно. Наприклад, шахрай надішле фальшиве сповіщення “замовлення оплачено”, і ви віддасте неоплачене замовлення.
 

З підписом таке не пройде. Ваш сервер обчислює підпис тим самим ключем і порівнює його з отриманим. Якщо підписи не співпали, значить сповіщення підроблене або змінене.

 

Якщо щось пішло не так

• Якщо ваш сервіс тимчасово недоступний, FoodSoul ще кілька разів спробує доставити сповіщення протягом 10 годин. Короткий збій або перезавантаження сервера не призведуть до втрати подій.
• Якщо проблема затягнеться, підписку буде вимкнено, а вам надійде лист: так ви дізнаєтеся про проблему.
• Щоб знову увімкнути підписку, напишіть у техпідтримку. Там же можна повторно надіслати сповіщення, які не дійшли під час збою.
   

Детальний опис подій і формату даних — у документації API.

З повагою, команда FoodSoul! Ми працюємо для Вас!