Zero Block
Click "Block Editor" to enter the edit mode. Use layers, shapes and customize adaptability. Everything is in your hands.
Tilda Publishing
create your own block from scratch
Zero Block
Click "Block Editor" to enter the edit mode. Use layers, shapes and customize adaptability. Everything is in your hands.
Tilda Publishing
create your own block from scratch
Вебхуки
Що це і як налашувати
Відео-інструкція
Вебхук — це зареєстрована в SyrveLoyalty адреса URL, на яку надсилаються сповіщення (запити) при виникненні певних подій. Для роботи з вебхуками вам потрібно налаштувати на своїй стороні сервер, готовий приймати та обробляти ці запити, а при необхідності надсилати повідомлення гостям.

API дозволяє працювати з веб-хуками. Підписавшись на вебхуки, є можливість отримувати повідомлення про всі наступні події:
  • про зміну статусу доставки
  • про помилку збереження доставкового замовлення
  • про зміну резерву
  • про помилку збереження резерву
  • про зміну статусу замовлення на стіл
  • про помилку збереження замовлення на стіл
  • про оновлення стоп-листа
Для одного organizationId можна задати тільки один URL.
Текстова інструкція для налаштування вебхуків для API Transport

1) Задати налаштування вебхуків можна за допомогою звичайного POST-запиту до АПІ:

https://api-eu.syrve.live/api/1/webhooks/update_settings

В тілі запиту передаютсья наступні параметри

{
    "organizationId": "{{orgId}}",
    "webHooksUri": "https://01j5xbe81k0618jhh51rc5e5bd00-f2a868870639f341a1b6.requestinspector.com",
    "authToken": "",
    "webHooksFilter": {
        "deliveryOrderFilter": {
            "orderStatuses": [
                "Unconfirmed",
                "WaitCooking",
                "ReadyForCooking",
                "CookingStarted",
                "CookingCompleted",
                "Waiting",
                "OnWay",
                "Delivered",
                "Closed",
                "Cancelled"
            ],
            "itemStatuses": [
                "Added",
                "PrintedNotCooking",
                "CookingStarted",
                "CookingCompleted",
                "Served"
            ],
            "errors": true //or false (its boolean)
        },
        "tableOrderFilter": {
            "orderStatuses": [
                "New",
                "Bill",
                "Closed",
                "Deleted"
            ],
            "itemStatuses": [
                "Added",
                "PrintedNotCooking",
                "CookingStarted",
                "CookingCompleted",
                "Served"
            ],
            "errors": true //or false (its boolean)  
        },
        "reserveFilter": {
            "updates": true, //or false (its boolean)  
            "errors": true //or false (its boolean)  
        },
        "stopListUpdateFilter": {
            "updates": true //or false (its boolean)  
        },
        "personalShiftFilter": {
            "updates": true //or false (its boolean)  
        },
        "nomenclatureUpdateFilter": {
            "updates": true //or false (its boolean)  
        }
    }
}

Всі параметри, які перераховані через кому в рамках квадратних дужок (мова про "[ ]") - це значення типу Enum, тобто вони мають записуватись саме так, але є опціональними

Тобто можна непотрібні значення прибрати, якщо отримувати сповіщення конкретно на це значення не потрібно


2) Задати налаштування вебхуків можна через інтерфейс iikoWeb:

3) Подивитися збережені налаштування можна POST-запитом до АПІ:

https://api-eu.syrve.live/api/1/webhooks/settings
4) Вебхук про зміну стоп-листа є лише повідомленням, що стоп-лист було змінено, і потрібно виконати метод опитування стоп-листів
https://api-eu.syrve.live/api/1/stop_lists
У тілі відповіді самого вебхука позиції зі стоп-листів не приходять.

Після того, як параметри виклику веб-хуків задані, транспорт при створенні/редагуванні/видаленні доставки/резерву/замовлення буде робити POST-запит на вказаний в налаштуваннях URL (токен авторизації передаватиметься в заголовку Authorization). В body передається інформація про змінену доставку / резерв / замовлення.
Якщо виклик методу веб-хука не вдався, протягом години будуть відбуватися повторні спроби його виклику кожні 10 хвилин.
Текстова інструкція для налаштування вебхуків для Syrve Loyalty
Після того, як ви налаштуєте підписку на сповіщення (вебхуки) на вкладці Webhook-повідомлення, ви зможете використовувати її для налаштування обміну повідомленнями та програм лояльності. Можна додати кілька підписок і використовувати їх для різних сповіщень.
З нашого боку приходить лише вебхук про певну подію
Інформування гостя про цю подію в UI - це задача додатку/сайту, а отже - задача інтегратора
Інтегратори мають переформатувати отриманий від нас вебхук в "читабельний" вигляд і вивести в UI сайту/додатку гостю
1) У розділі Установки перейдіть на вкладку Webhook-повідомлення.
2) Натисніть кнопку Створити.
3) Введіть назву нової передплати.
4) У полі URL надсилання webhook-повідомлень вкажіть адресу служби сповіщень, яку ви отримали у інтегратора або розробника сервісу.
Повідомлення будуть надсилатися на цю адресу, а потім перенаправлятися до обраної служби (наприклад, до месенджера, соціальних мереж, СМС-провайдера або стороннього додатка).
Щоб перевірити, чи обмін повідомленнями працює, вкажіть Тестовий телефон і натисніть Тест.
5) Вкажіть пароль, отриманий від інтегратора.
6) Позначте потрібні категорії сповіщень та натисніть Зберегти.
Вебхуки можна використовувати при створенні рекламних розсилок, відправці нагадувань та повідомлень про бонусний баланс, при додаванні нових акцій, створенні бонусних програм, реєстрації електронних гаманців тощо.