Webhook отримання оновлень по Боксам

Призначення: цей вебхук повідомляє про будь-яку зміну стану Бокса в Expirenza (створення, викуп, повернення до доступності, редагування рестораном).


1. Опис

  • Подія надсилається, коли:

    • створено новий Бокс (з’явився у продажу);

    • усі порції викуплено (availableQuantity = 0);

    • Бокс знову став доступним (після відмови клієнта);

    • змінено назву, опис, ціну, time-slot тощо.

Expirenza залишає за собою право призупинити або вимкнути вебхук для будь-якого інтегратора без попередження.


2. Як підписатися

  1. Заповніть форму:

    • Номер телефону — для швидкого контакту.

    • E-mail — для технічних сповіщень.

    • URL — endpoint, що прийматиме POST.

  2. Посилання на форму тут.

  3. Після модерації ми активуємо надсилання подій на вказаний URL.

  4. Expirenza залишає за собою право призупинити або вимкнути вебхук для будь-якого інтегратора без попередження.


3. Специфікація та приклад

Подія надсилається при створенні, зміні чи викупі Бокса

Payload
idstring · uuidRequired

Унікальний ідентифікатор Бокса

namestringRequired

Назва Бокса

descriptionstringOptional

Маркетинговий опис

statusstringOptional

Статус пропозиції (ACTIVE, SOLD_OUT, EXPIRED)

propositionImageUrlstring · uriOptional

Обкладинка Бокса

pricenumberRequired

Актуальна ціна, грн

originalPricenumberOptional

Початкова ціна, грн

totalQuantityintegerRequired

Загальна кількість пропозицій

availableQuantityintegerRequired

Кількість доступних пропозицій

publicLinkstring · uriOptional

Публічне посилання на Бокс

tlmintegerOptional

Epoch-мілісекунди, коли зафіксовано зміну

Responses
200
Подію успішно прийнято

Payload

{
  "id": "72b5b1aa-ba8f-47e6-9339-29a93a15401e",
  "name": "Бокс від Expirenza Restaurant",
  "description": "Ви знаєте правила? ...",
  "status": "ACTIVE",
  "propositionImageUrl": "https://docs.expirenza.com/box.jpeg",
  "timeSlot": {
    "startDate": "2025-05-06T18:00:16.114+03:00",
    "endDate": "2025-05-06T20:00:16.114+03:00"
  },
  "price": 259,
  "originalPrice": 450,
  "totalQuantity": 2,
  "availableQuantity": 1,
  "publicLink": "https://expz.menu/box/oUJP/uKok",
  "restaurant": {
    "name": "Expirenza Restaurant",
    "address": "вул. Шевченко, буд. 2",
    "city": "м. Київ",
    "coordinates": {
      "lat": 46.4316604,
      "lng": 30.7260031
    }
  },
  "tlm": 1746535104036
}

Заголовки Accept, Content-Type: application/json та Content-Length додаються автоматично і тут не дублюються.


4. Очікувана відповідь клієнта

HTTP код
Коли надсилати

200

Подія успішно оброблена

Будь-який інший код (4xx/5xx) трактуватиметься як помилка, і подію буде надіслано повторно з експоненційною затримкою.


5. Застереження щодо змін

Expirenza може додавати нові необов’язкові поля або розширювати словники без попереднього повідомлення. Переконайтеся, що парсер ігнорує невідомі атрибути, щоб інтеграція залишалася стійкою.


6. Зміни версій

Дата
Версія
Опис

2025-05-07

1.0.0

Початкова версія

Last updated