Вебхуки
Перейдите в Настройки, если они вам доступны, из левого навигационного меню, чтобы выполнить действие.
Вебхуки – это триггеры, которые запускаются после выполнения определенных действий в solOS. Триггеры отправляют данные через POST-запрос на URL-адрес (Endpoint), который указывается в настройках системы.
Вебхуки используются в различных сценариях, например, для отправки сообщений в WhatsApp после добавления контакта, формирования счетов через эквайринг, отправки счёта клиенту на Email и многого другого. Совмещайте вебхуки вместе с возможностями API для реализации разнообразных сценариев и бизнес-процессов.
Вебхуки активируются как при работе внутри solOS, так и при вызове 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 |
---|---|
Проекты. Добавить проект |
Проект: 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 Лизинг |
Проекты. Редактировать проект |
Проект: 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 Лизинг: prepayment, leasing_period, amount_leasing_agreement, nds, delivery_date, early_redemption |
Проекты. Удалить проект | id |
Проекты. Добавить событие | id, project_id, action_id, comment |
Проекты. Редактировать событие | id, project_id, comment |
Проекты. Удалить событие | id, project_id |
Проекты. Добавить задачу | id, project_id, type_id, name, deadline, priority, slave_id |
Проекты. Редактировать задачу | id, project_id, name |
Проекты. Открыть задачу | id, project_id |
Проекты. Сменить исполнителя | id, project_id, user_id |
Проекты. Закрыть задачу | id, project_id |
Проекты. Перенести задачу | id, project_id, deadline |
Проекты. Удалить задачу | id, project_id |
Проекты. Добавить продукт | id, project_id, good_id, comment, quantity, price, amount |
Проекты. Редактировать продукт
|
id, project_id, good_id, comment, quantity, price, amount |
Проекты. Удалить продукт | id, project_id |
Проекты. Изменить этап | id, project_id, step_id, comment |
Проекты. Добавить платёж | id, project_id, payment_date, price, currency_id, name, expense |
Проекты. Редактировать платёж
|
id, project_id, payment_date, price, currency_id, name, expense |
Проекты. Удалить платёж | id, project_id |
Проекты. Добавить счёт | id, project_id, invoice_number, invoice_date |
Проекты. Удалить счёт | id, project_id |
Проекты. Добавить SLA
|
id, project_id, name, start, end, comment, resolution_time, priority, resolution_days, resolution_start, resolution_end, contact_id |
Проекты. Редактировать SLA
|
id, project_id, name, start, end, comment, resolution_time, priority, resolution_days, resolution_start, resolution_end, contact_id |
Проекты. Удалить SLA
|
id, project_id |
Лизинг. Обновить график платежей | project_id |
Лизинг. Добавить участника | project_id, type_id, client_id, comment |
Лизинг. Удалить участника | id, project_id |
Группы проектов. Добавить группу | id, name, comment |
Группы проектов. Редактировать группу | id, name, comment |
Группы проектов. Удалить группу | id |
Техподдержка. Добавить заявку | id, project_id, contact_id, source, sla_id, sla_name, sla_comment, sla_resolution_time, sla_priority, name, deadline, user_id, slave_id |
Техподдержка. Добавить событие | id, helpdesk_id, main_status, internal_status, closure_code, type, name |
Техподдержка. Редактировать событие | id, helpdesk_id, name |
Техподдержка. Сменить ответственного | helpdesk_id, user_id |
Техподдержка. Сменить исполнителя | helpdesk_id, user_id |
Лиды. Добавить лид | id, user_id, status_id, name, phone, email, reference_id, comment |
Лиды. Редактировать лид | id, name, phone, email, reference_id, comment |
Лиды. Удалить лид | id |
Лиды. Изменить статус | id, status_id |
Лиды. Добавить событие | id, lead_id, name |
Лиды. Редактировать событие | id, lead_id, name |
Лиды. Удалить событие | id, lead_id |
Лиды. Добавить задачу | id, lead_id, name, deadline |
Лиды. Редактировать задачу | id, lead_id, name |
Лиды. Открыть задачу | id, lead_id |
Лиды. Закрыть задачу | id, lead_id |
Лиды. Перенести задачу | id, lead_id, deadline |
Лиды. Удалить задачу | id, lead_id |
Календарь. Добавить событие | id, category_id, name, description, start, end, repeat_type |
Календарь. Редактировать событие | id, category_id, name, description, start, end, all_day |
Календарь. Удалить событие | id |
Контрагенты. Добавить контрагента | id, name, name_full, ogrn, inn, kpp, legal_address, actual_address, phone, email, url, comment |
Контрагенты. Редактировать контрагента | id, name, name_full, ogrn, inn, kpp, legal_address, actual_address, phone, email, url, comment |
Контрагенты. Удалить контрагента | id |
Контакты. Добавить контакт | id, client_id, name, position, phone_1, phone_2, email_1, email_2, telegram, bday, comment |
Контакты. Редактировать контакт | id, client_id, name, position, phone_1, phone_2, email_1, email_2, telegram, bday, comment |
Контакты. Удалить контакт | id |
Отчёты. Добавить отчёт | id, name, text, created, client_id, category_id, city_id |
Отчёты. Редактировать отчёт | id, name, text, created, client_id, category_id, city_id |
Отчёты. Удалить отчёт | id |
Каталог. Добавить категорию продуктов | id, name, comment |
Каталог. Редактировать категорию продуктов | id, name, comment |
Каталог. Удалить категорию продуктов | id |
Каталог. Добавить продукт | id, category_id, name, vendor_code, comment |
Каталог. Редактировать продукт | id, category_id, name, vendor_code, comment |
Каталог. Удалить продукт | id |
Cloud. Добавить файл | id, category_id, name |
Cloud. Редактировать файл | id, category_id, name |
Cloud. Обновить файл | id |
Cloud. Удалить файл | id |
Финансы. Привязать платёж | id, project_id |
Выгрузка данных. Проекты |
только служебные поля
|
Выгрузка данных. Техподдержка |
только служебные поля
|
Выгрузка данных. Лиды |
только служебные поля
|
Выгрузка данных. Календарь |
только служебные поля
|
Выгрузка данных. Контрагенты |
только служебные поля
|
Выгрузка данных. Контакты |
только служебные поля
|
Пользователи. Добавить пользователя | id, user_group_id, login, surname, name, patronymic, initials, phone, internal_number, pushkey, active |
Пользователи. Редактировать пользователя | id, user_group_id, login, surname, name, patronymic, initials, phone, internal_number, pushkey, active |
Пользователи. Изменить пароль | user_id |
Пользователи. Права доступа | user_id |
Пользователи. Передать данные | projects, project_todos, project_groups, helpdesk, leads, lead_todos, calendar, clients, contacts, reports, catalog, cloud, users, user_groups, user_id |
Пользователи. Доступ к API | user_id |
Пользователи. Авторизация |
только служебные поля
|
Пользователи. Выход из системы |
только служебные поля
|
Группы пользователей. Добавить группу | id, name, comment |
Группы пользователей. Редактировать группу | id, name, comment |
Группы пользователей. Права доступа группы | id |
Группы пользователей. Удалить группу | id |
Кроме того, в Body автоматически добавляются служебные поля:
- _user_id – ID-пользователя, который инициировал вебхук;
- _user_initials
API– инициалы пользователя, который инициировал вебхук; - _user_ip
API– IP-адрес пользователя, который инициировал вебхук; - _user_location
API– местоположение пользователя, который инициировал вебхук; - _user_agent
API– User-Agent пользователя, который инициировал вебхук.