Вебхуки CARBOOK дозволяють отримати інформацію про наряд – замовлення при створенні або його зміні.
Для налаштування вебхуків треба перейти в розділ “Налаштування СТО” -> “Вебхуки”. Дане вікно доступне в пакеті Майстер та Експерт, для посади Керівник або Admin. Таб “Вебхуки” містить два підтаби “Таблиця вебхуків” та “Логи вебхуків”.
В таблиці вебхуків можливо додати вебхук, редагувати його, та протестувати перед роботою, видалити чи активувати/деактивувати – для цього є необхідні опції в меню бургер в кожному рядку.
Для створення нового вебхука, треба скористатись кнопкою “плюс” в правому верхньому куті. Заповніть необхідні поля та збережіть. Нижче є опис всіх можливих полів, які можна передати через вебхук. Доступно для авторизації: Bearer, Basic та Custom.
Після додавання та збереження, можна протестувати роботу доданого вебхука.
Опис змінних для користувачів CARBOOK
Нижче наведено опис змінних для наряду-замовлення (Н/З) в системі CARBOOK, які використовуються в мануалі для користувачів. Опис адаптовано для зрозумілості та відповідає логіці системи.
| Змінна | Опис |
|---|---|
id | Унікальний ідентифікатор наряду-замовлення (Н/З). Наприклад: 2107133. |
businessId | Ідентифікатор бізнесу (СТО) в системі. Наприклад: 4958. |
datetime | Дата та час створення Н/З. Формат: РРРР-ММ-ДДTГГ:ХХ:СС. Наприклад: 2025-04-25T17:12:18.034851. |
status | Статус Н/З (наприклад, reserve — зарезервовано, in_progress, completed). |
beginDatetime | Дата та час початку виконання Н/З. Наприклад: 2025-04-25T17:07:00. |
duration | Тривалість виконання Н/З. Формат: ГГ:ХХ:СС. Наприклад: 00:30:00. |
employeeId | Ідентифікатор працівника, призначеного на Н/З. Якщо не призначено — null. |
stationNum | Номер станції (поста) на СТО, де виконується Н/З. Якщо не вказано — null. |
clientId | Ідентифікатор клієнта. Якщо не вказано — null. |
clientVehicleId | Ідентифікатор автомобіля клієнта. Якщо не вказано — null. |
vehicleNumber | Державний номер автомобіля. Якщо не вказано — null. |
odometerValue | Пробіг автомобіля на момент Н/З. Якщо не вказано — null. |
comment | Коментар до Н/З. За замовчуванням: Коментар відсутній. |
clientPhone | Телефонний номер клієнта. Наприклад: 38(063) 166-66-98. |
clientEmail | Електронна пошта клієнта. Якщо не вказано — null. |
viewDatetime | Дата та час останнього перегляду Н/З. Наприклад: 2025-04-28T13:07:25.967. |
orderNum | Повний код Н/З для ідентифікації. Наприклад: RD-4958-2107133. |
paymentMethod | Спосіб оплати Н/З (наприклад, noncash — безготівковий, cash — готівка). |
successDatetime | Дата та час завершення Н/З Якщо не завершено — null. |
servicesSum | Загальна сума за роботи. Наприклад: 0. |
servicesDiscount | Знижка на роботи. Якщо відсутня — null. |
appurtenanciesSum | Загальна сума за запчастини. Наприклад: 0. |
appurtenanciesDiscount | Знижка на запчастини. Якщо відсутня — null. |
managerId | Ідентифікатор менеджера, відповідального за Н/З. Якщо не вказано — null. |
updateDatetime | Дата та час останнього оновлення Н/З. Наприклад: 2025-04-30T11:18:17.953201. |
requisiteId | Ідентифікатор реквізитів СТО для Н/З. Якщо не вказано — null. |
clientRequisiteId | Ідентифікатор реквізитів клієнта для Н/З. Якщо не вказано — null. |
appurtenanciesResponsibleId | Ідентифікатор механіка, відповідального за запчастини. Якщо не вказано — null. |
deliveryDatetime | Дата та час видачі автомобіля клієнту. Наприклад: 2025-04-25T19:07:00+02:00. |
clientVehicleTypeId | Тип автомобіля клієнта (наприклад, 1 — легковий). |
calculationLink | Посилання на калькуляцію Н/З. Якщо відсутнє — null. |
discount | Загальна знижка на Н/З. Якщо відсутня — null. |
clientAggregateId | Ідентифікатор агрегата, якщо ремонт стосується агрегата, а не автомобіля. Якщо не вказано — null. |
orderBloke | Тип ремонту (наприклад, VEHICLE — автомобіль, AGGREGATE — агрегат). |
responsibleId | Ідентифікатор відповідальної особи за Н/З. Якщо не вказано — null. |
substatus | Підстатус Н/З, що корелюється зі статусом (наприклад, auto для автоматизованих дій). |
recipient | Номер приймаючого дзвінок. Якщо не вказано — null. |
systemComment | Системний коментар, невидимий для клієнтів. Якщо відсутній — null. |
agreementComment | Коментар щодо узгодження Н/З. Якщо відсутній — null. |
servicesPurchaseTotalSum | Загальна закупівельна ціна робіт зі знижкою. Якщо не вказано — null. |
servicesPurchaseSum | Закупівельна ціна робіт. Якщо не вказано — null. |
servicesSubPurchaseSum | Закупівельна ціна субпідрядних робіт. Якщо не вказано — null. |
servicesOwnSum | Закупівельна ціна власних робіт. Якщо не вказано — null. |
servicesSubSum | Загальна сума субпідрядних робіт. Якщо не вказано — null. |
appurtenanciesPurchaseSum | Закупівельна ціна запчастин. Наприклад: 12636. |
totalSum | Загальна сума Н/З. Наприклад: 0. |
totalSumTax | Загальна сума Н/З з урахуванням ПДВ. Наприклад: 0. |
storageHashes | Хеші для зберігання даних. Якщо не використовується — null. |
kind | Тип Н/З (наприклад, ORD — замовлення, RTL — роздріб, RTN — повернення). |
orderParentId | Ідентифікатор батьківського Н/З, якщо є зв’язок. Якщо відсутній — null. |
Примітки
- Значення
nullвказує на відсутність даних у полі. - Деякі поля (наприклад,
servicesPurchaseSum,servicesSubPurchaseSum) використовуються для внутрішніх розрахунків і можуть бути заповнені лише в певних випадках. - Поля, пов’язані з фінансами (наприклад,
totalSum,appurtenanciesPurchaseSum), відображають суми в гривнях або іншій валюті, визначеній у налаштуваннях СТО.
Логи вебхуків
“Налаштування СТО” – таб “Вебхуки” – “Логи вебхуків”. Приклад тестування нового доданого вебхука.