Вебхуки
Перейдите в Настройки, если они вам доступны, из левого навигационного меню, чтобы выполнить действие.
Вебхуки – это триггеры, которые запускаются после выполнения определенных действий в solOS. Триггеры отправляют данные через POST-запрос на URL-адрес (Endpoint), который указывается в настройках системы.
Вебхуки используются в различных сценариях, например, для отправки сообщений в WhatsApp после добавления контакта, формирования счетов через эквайринг, отправки счёта клиенту на Email и многого другого. Совмещайте вебхуки вместе с возможностями API для реализации разнообразных сценариев и бизнес-процессов.
Вебхуки активируются как в процессе работы пользователей в solOS, так и при использовании API-методов, отмеченных как API. Имейте в виду, что не вся информация доступна через API-методы: такие методы помечены как API рядом с соответствующими полями.
Вебхук активируется только один раз. Если ваш сервер-обработчик недоступен, данные не будут сохраняться и повторно отправляться.
Вебхуки позволяют внешним службам получать уведомления об определенных событиях. Когда указанные события произойдут, мы отправим POST-запрос на каждый из предоставленных вами URL-адресов.
Для того, чтобы использовать вебхуки, надо сделать несколько действий:
- Разработать скрипт, который будет обрабатывать данные, поступающие от solOS методом POST;
- Опубликовать скрипт на веб-хостинге;
- Указать прямой URL скрипта в качестве Endpoint в настройках solOS для конкретного действия.
Вы можете сделать тестовый POST-запрос на Endpoint https://share.solos.pro/webhook.php
Этот PHP-скрипт приведен ниже:
<?php
foreach ($_POST as $key => $val) {
echo "<div>[$key] => $val</div>";
}
?>
Доступные вебхуки
| Действие | Body |
|---|---|
|
Проекты. Добавить проект
projects-create
|
Проект: id, name, client_id, contractor_id, start, end, price, currency_id, contract_number, contract_date, city_id, step_id, project_group_id, reference_id, lead_id, comment Лизинг: leasing_prepayment, leasing_period, leasing_amount, leasing_nds, leasing_delivery, leasing_is_paid_early, leasing_agent_amount, leasing_agent_date, leasing_supplier_amount, leasing_supplier_date, leasing_insurance_amount, leasing_insurance_date |
|
Проекты. Добавить проектAPI
projects-create
|
Проект: id, name, client_id, contractor_id, start, end, price, currency_id, contract_number, contract_date, city_id, step_id, project_group_id, reference_id, lead_id, comment |
|
Проекты. Редактировать проект
projects-edit
|
Проект: id, name, client_id, contractor_id, start, end, price, currency_id, contract_number, contract_date, city_id, project_group_id, reference_id, lead_id, comment, active Лизинг: leasing_prepayment, leasing_period, leasing_amount, leasing_nds, leasing_delivery, leasing_is_paid_early, leasing_agent_amount, leasing_agent_date, leasing_supplier_amount, leasing_supplier_date, leasing_insurance_amount, leasing_insurance_date |
|
Проекты. Редактировать проектAPI
projects-edit
|
Проект: id |
|
Проекты. Удалить проект
projects-delete
|
id |
|
Проекты. Удалить проектAPI
projects-delete
|
id |
|
Проекты. Добавить событие
projects-create-action
|
id, project_id, type_id, name |
|
Проекты. Добавить событиеAPI
projects-create-action
|
id, project_id, type_id, name |
|
Проекты. Редактировать событие
projects-edit-action
|
id, project_id, name |
|
Проекты. Редактировать событиеAPI
projects-edit-action
|
id, project_id |
|
Проекты. Удалить событие
projects-delete-action
|
id, project_id |
|
Проекты. Удалить событиеAPI
projects-delete-action
|
id, project_id |
|
Проекты. Добавить задачу
projects-create-todo
|
id, project_id, type_id, name, deadline, priority, slave_id |
|
Проекты. Добавить задачуAPI
projects-create-todo
|
id, project_id, type_id, name, deadline, priority, slave_id |
|
Проекты. Редактировать задачу
projects-edit-todo
|
id, project_id, name |
|
Проекты. Редактировать задачуAPI
projects-edit-todo
|
id, project_id |
|
Проекты. Открыть задачу
projects-open-todo
|
id, project_id |
|
Проекты. Открыть задачуAPI
projects-open-todo
|
id, project_id |
|
Проекты. Сменить исполнителя задачи
projects-change-todo-slave
|
id, project_id, user_id |
|
Проекты. Сменить исполнителя задачиAPI
projects-change-todo-slave
|
id, project_id, user_id |
|
Проекты. Закрыть задачу
projects-complete-todo
|
id, project_id |
|
Проекты. Закрыть задачуAPI
projects-complete-todo
|
id, project_id |
|
Проекты. Перенести задачу
projects-reschedule-todo
|
id, project_id, deadline |
|
Проекты. Перенести задачуAPI
projects-reschedule-todo
|
id, project_id, deadline |
|
Проекты. Удалить задачу
projects-delete-todo
|
id, project_id |
|
Проекты. Удалить задачуAPI
projects-delete-todo
|
id, project_id |
|
Проекты. Добавить продукт
projects-add-good
|
id, project_id, good_id, comment, quantity, price, amount |
|
Проекты. Добавить продуктAPI
projects-add-good
|
id, project_id, good_id, comment, quantity, price, amount |
|
Проекты. Редактировать продукт
projects-edit-good
|
id, project_id, good_id, comment, quantity, price, amount |
|
Проекты. Редактировать продуктAPI
projects-edit-good
|
id, project_id |
|
Проекты. Удалить продукт
projects-delete-good
|
id, project_id |
|
Проекты. Удалить продуктAPI
projects-delete-good
|
id, project_id |
|
Проекты. Изменить этап
projects-change-step
|
id, project_id, step_id, comment |
|
Проекты. Изменить этапAPI
projects-change-step
|
id, project_id, step_id, comment |
|
Проекты. Редактировать этап
projects-edit-step
|
id, project_id, comment |
|
Проекты. Редактировать этапAPI
projects-edit-step
|
id, project_id |
|
Проекты. Добавить платёж
projects-create-payment
|
id, project_id, payment_date, price, currency_id, name, expense |
|
Проекты. Добавить платёжAPI
projects-create-payment
|
id, project_id, payment_date, price, currency_id, name, expense |
|
Проекты. Редактировать платёж
projects-edit-payment
|
id, project_id, payment_date, price, currency_id, name, expense |
|
Проекты. Редактировать платёжAPI
projects-edit-payment
|
id, project_id, expense |
|
Проекты. Удалить платёж
projects-delete-payment
|
id, project_id, expense |
|
Проекты. Удалить платёжAPI
projects-delete-payment
|
id, project_id, expense |
|
Проекты. Добавить счёт
projects-create-invoice
|
id, project_id, invoice_number, invoice_date |
|
Проекты. Добавить счётAPI
projects-create-invoice
|
id, project_id, invoice_number, invoice_date |
|
Проекты. Удалить счёт
projects-delete-invoice
|
id, project_id |
|
Проекты. Удалить счётAPI
projects-delete-invoice
|
id, project_id |
|
Проекты. Добавить SLA
projects-create-sla
|
id, project_id, name, start, end, comment, resolution_time, priority, resolution_days, resolution_start, resolution_end, contact_id |
|
Проекты. Редактировать SLA
projects-edit-sla
|
id, project_id, name, start, end, comment, resolution_time, priority, resolution_days, resolution_start, resolution_end, contact_id |
|
Проекты. Удалить SLA
projects-delete-sla
|
id, project_id |
|
Лизинг. Обновить график платежей
leasing-create-schedule
|
project_id |
|
Лизинг. Обновить график платежейAPI
leasing-create-schedule
|
project_id |
|
Лизинг. Добавить участника сделки
leasing-add-participant
|
project_id, type_id, client_id, comment |
|
Лизинг. Добавить участника сделкиAPI
leasing-add-participant
|
project_id, type_id, client_id, comment |
|
Лизинг. Удалить участника сделки
leasing-delete-participant
|
id, project_id |
|
Лизинг. Удалить участника сделкиAPI
leasing-delete-participant
|
id, project_id |
|
Группы проектов. Добавить группу
project-groups-create
|
id, name, comment |
|
Группы проектов. Добавить группуAPI
project-groups-create
|
id, name, comment |
|
Группы проектов. Редактировать группу
project-groups-edit
|
id, name, comment |
|
Группы проектов. Редактировать группуAPI
project-groups-edit
|
id |
|
Группы проектов. Удалить группу
project-groups-delete
|
id |
|
Группы проектов. Удалить группуAPI
project-groups-delete
|
id |
|
Техподдержка. Добавить заявку
helpdesk-create
|
id, action_id, project_id, contact_id, source, sla_id, sla_name, sla_comment, sla_resolution_time, sla_priority, name, deadline, user_id, slave_id |
|
Техподдержка. Добавить заявкуAPI
helpdesk-create
|
id, action_id, project_id, contact_id, source, sla_id, sla_name, sla_comment, sla_resolution_time, sla_priority, name, deadline, user_id |
|
Техподдержка. Добавить событие
helpdesk-create-action
|
id, helpdesk_id, main_status, internal_status, closure_code, type, name |
|
Техподдержка. Добавить событиеAPI
helpdesk-create-action
|
id, helpdesk_id, main_status, internal_status, closure_code, type, name |
|
Техподдержка. Редактировать событие
helpdesk-edit-action
|
id, helpdesk_id, name |
|
Техподдержка. Редактировать событиеAPI
helpdesk-edit-action
|
id, helpdesk_id |
|
Техподдержка. Сменить ответственного по заявке
helpdesk-change-owner
|
helpdesk_id, user_id |
|
Техподдержка. Сменить ответственного по заявкеAPI
helpdesk-change-owner
|
helpdesk_id, user_id |
|
Техподдержка. Сменить исполнителя по заявке
helpdesk-change-slave
|
helpdesk_id, user_id |
|
Техподдержка. Сменить исполнителя по заявкеAPI
helpdesk-change-slave
|
helpdesk_id, user_id |
|
Лиды. Добавить лид
leads-create
|
id, user_id, status_id, name, phone, email, reference_id, comment |
|
Лиды. Добавить лидAPI
leads-create
|
id, user_id, status_id, name, phone, email, reference_id, comment |
|
Лиды. Редактировать лид
leads-edit
|
id, name, phone, email, reference_id, comment |
|
Лиды. Редактировать лидAPI
leads-edit
|
id |
|
Лиды. Удалить лид
leads-delete
|
id |
|
Лиды. Удалить лидAPI
leads-delete
|
id |
|
Лиды. Изменить статус
leads-change-status
|
id, status_id |
|
Лиды. Изменить статусAPI
leads-change-status
|
id, status_id |
|
Лиды. Добавить событие
leads-create-action
|
id, lead_id, name |
|
Лиды. Добавить событиеAPI
leads-create-action
|
id, lead_id, name |
|
Лиды. Редактировать событие
leads-edit-action
|
id, lead_id, name |
|
Лиды. Редактировать событиеAPI
leads-edit-action
|
id, lead_id |
|
Лиды. Удалить событие
leads-delete-action
|
id, lead_id |
|
Лиды. Удалить событиеAPI
leads-delete-action
|
id, lead_id |
|
Лиды. Добавить задачу
leads-create-todo
|
id, lead_id, name, deadline |
|
Лиды. Добавить задачуAPI
leads-create-todo
|
id, lead_id, name, deadline |
|
Лиды. Редактировать задачу
leads-edit-todo
|
id, lead_id, name |
|
Лиды. Редактировать задачуAPI
leads-edit-todo
|
id, lead_id |
|
Лиды. Открыть задачу
leads-open-todo
|
id, lead_id |
|
Лиды. Открыть задачуAPI
leads-open-todo
|
id, lead_id |
|
Лиды. Закрыть задачу
leads-complete-todo
|
id, lead_id |
|
Лиды. Закрыть задачуAPI
leads-complete-todo
|
id, lead_id |
|
Лиды. Перенести задачу
leads-reschedule-todo
|
id, lead_id, deadline |
|
Лиды. Перенести задачуAPI
leads-reschedule-todo
|
id, lead_id, deadline |
|
Лиды. Удалить задачу
leads-delete-todo
|
id, lead_id |
|
Лиды. Удалить задачуAPI
leads-delete-todo
|
id, lead_id |
|
Календарь. Добавить событие
calendar-create
|
id, category_id, name, description, start, end, repeat_type, repeat_times, all_day, project_id, todo_id |
|
Календарь. Добавить событиеAPI
calendar-create
|
id, category_id, name, description, start, end, all_day |
|
Календарь. Редактировать событие
calendar-edit
|
id, category_id, name, description, start, end, all_day |
|
Календарь. Редактировать событиеAPI
calendar-edit
|
id |
|
Календарь. Удалить событие
calendar-delete
|
id |
|
Календарь. Удалить событиеAPI
calendar-delete
|
id |
|
Контрагенты. Добавить контрагента
clients-create
|
id, name, name_full, ogrn, inn, kpp, legal_address, actual_address, phone, email, url, comment |
|
Контрагенты. Добавить контрагентаAPI
clients-create
|
id, name, name_full, ogrn, inn, kpp, legal_address, actual_address, phone, email, url, comment |
|
Контрагенты. Редактировать контрагента
clients-edit
|
id, name, name_full, ogrn, inn, kpp, legal_address, actual_address, phone, email, url, comment |
|
Контрагенты. Редактировать контрагентаAPI
clients-edit
|
id |
|
Контрагенты. Удалить контрагента
clients-delete
|
id |
|
Контрагенты. Удалить контрагентаAPI
clients-delete
|
id |
|
Контакты. Добавить контакт
contacts-create
|
id, client_id, name, position, phone_1, phone_2, email_1, email_2, telegram, bday, comment |
|
Контакты. Добавить контактAPI
contacts-create
|
id, client_id, name, position, phone_1, phone_2, email_1, email_2, telegram, bday, comment |
|
Контакты. Редактировать контакт
contacts-edit
|
id, client_id, name, position, phone_1, phone_2, email_1, email_2, telegram, bday, comment |
|
Контакты. Редактировать контактAPI
contacts-edit
|
id |
|
Контакты. Удалить контакт
contacts-delete
|
id |
|
Контакты. Удалить контактAPI
contacts-delete
|
id |
|
Отчёты. Добавить отчёт
reports-create
|
id, name, text, created, client_id, category_id, city_id |
|
Отчёты. Добавить отчётAPI
reports-create
|
id, name, text, created, client_id, category_id, city_id |
|
Отчёты. Редактировать отчёт
reports-edit
|
id, name, text, created, client_id, category_id, city_id |
|
Отчёты. Редактировать отчётAPI
reports-edit
|
id |
|
Отчёты. Удалить отчёт
reports-delete
|
id |
|
Отчёты. Удалить отчётAPI
reports-delete
|
id |
|
Каталог. Добавить категорию продуктов
catalog-categories-create
|
id, name, comment |
|
Каталог. Добавить категорию продуктовAPI
catalog-categories-create
|
id, name, comment |
|
Каталог. Редактировать категорию продуктов
catalog-categories-edit
|
id, name, comment |
|
Каталог. Редактировать категорию продуктовAPI
catalog-categories-edit
|
id |
|
Каталог. Удалить категорию продуктов
catalog-categories-delete
|
id |
|
Каталог. Удалить категорию продуктовAPI
catalog-categories-delete
|
id |
|
Каталог. Добавить продукт
catalog-goods-create
|
id, category_id, name, vendor_code, comment |
|
Каталог. Добавить продуктAPI
catalog-goods-create
|
id, category_id, name, vendor_code, comment |
|
Каталог. Редактировать продукт
catalog-goods-edit
|
id, category_id, name, vendor_code, comment |
|
Каталог. Редактировать продуктAPI
catalog-goods-edit
|
id |
|
Каталог. Удалить продукт
catalog-goods-delete
|
id |
|
Каталог. Удалить продуктAPI
catalog-goods-delete
|
id |
|
Cloud. Добавить файл
cloud-create
|
id, folder_id, name |
|
Cloud. Редактировать файл
cloud-edit
|
id, folder_id, name |
|
Cloud. Обновить файл
cloud-update
|
id |
|
Cloud. Удалить файл
cloud-delete
|
id |
|
Финансы. Привязать платёж
finances-bind-payment
|
id, project_id |
|
Выгрузка данных. Проекты
export-projects
|
только служебные поля
|
|
Выгрузка данных. Техподдержка
export-helpdesk
|
только служебные поля
|
|
Выгрузка данных. Лиды
export-leads
|
только служебные поля
|
|
Выгрузка данных. Календарь
export-calendar
|
только служебные поля
|
|
Выгрузка данных. Контрагенты
export-clients
|
только служебные поля
|
|
Выгрузка данных. Контакты
export-contacts
|
только служебные поля
|
|
Пользователи. Добавить пользователя
users-create
|
id, user_group_id, login, surname, name, patronymic, initials, phone, internal_number, pushkey, active |
|
Пользователи. Добавить пользователяAPI
users-create
|
id, user_group_id, login, surname, name, patronymic, initials, phone, internal_number, pushkey, active |
|
Пользователи. Редактировать пользователя
users-edit
|
id, user_group_id, login, surname, name, patronymic, initials, phone, internal_number, pushkey, active |
|
Пользователи. Изменить пароль
users-change-password
|
user_id |
|
Пользователи. Права доступа
users-access
|
user_id |
|
Пользователи. Передать данные
users-transfer
|
projects, project_todos, project_groups, helpdesk, leads, lead_todos, calendar, clients, contacts, reports, catalog, cloud, users, user_groups, user_id |
|
Пользователи. Доступ к API
users-api
|
user_id |
|
Пользователи. Авторизация
users-login
|
только служебные поля
|
|
Пользователи. Выход из системы
users-logout
|
только служебные поля
|
|
Группы пользователей. Добавить группу
user-groups-create
|
id, name, comment |
|
Группы пользователей. Добавить группуAPI
user-groups-create
|
id, name, comment |
|
Группы пользователей. Редактировать группу
user-groups-edit
|
id, name, comment |
|
Группы пользователей. Редактировать группуAPI
user-groups-edit
|
id |
|
Группы пользователей. Права доступа группы
user-groups-access
|
id |
|
Группы пользователей. Удалить группу
user-groups-delete
|
id |
|
Группы пользователей. Удалить группуAPI
user-groups-delete
|
id |
Кроме того, в Body автоматически добавляются служебные поля:
- _event – Служебное название события;
- _user_id – ID-пользователя, который инициировал вебхук;
- _user_initialsAPI – инициалы пользователя, который инициировал вебхук;
- _user_ipAPI – IP-адрес пользователя, который инициировал вебхук;
- _user_locationAPI – местоположение пользователя, который инициировал вебхук;
- _user_agentAPI – User-Agent пользователя, который инициировал вебхук.
Остались вопросы? Напишите нам, свяжитесь со службой поддержки или подпишитесь на наш Telegram-канал.