09 декабря 2022 г.

Вебхуки

Вебхуки – это триггеры, которые запускаются после выполнения определенных действий в solOS. Триггеры отправляют данные через POST-запрос на URL-адрес (Endpoint), который указывается в настройках системы.

Триггеры используются в разных сценариях, например, отправка сообщения в WhatsApp после добавления контакта, формирование счетов через эквайринг, отправка счёта клиента на Email и многое другое. Вебхуки запускаются только при работе внутри solOS – API не активирует вебхуки.

Вебхуки позволяют внешним службам получать уведомления об определенных событиях. Когда указанные события произойдут, мы отправим POST-запрос на каждый из предоставленных вами URL-адресов.

Для того, чтобы использовать триггеры, надо сделать несколько простых действий:

  1. Создать скрипт, который будет принимать данные от solOS;
  2. Разместить этот скрипт на хостинге;
  3. Прямой адрес к скрипту – это Endpoint, который надо указать в настройках solOS для определенного действия.

Вы можете сделать тестовый POST-запрос на Endpoint https://share.solos.pro/webhook.php

Этот PHP-скрипт приведен ниже:

<?php
foreach ($_POST as $key => $val) {
    echo "<div>[$key] => $val</div>";
}
?>

Комбинируйте вебхуки вместе с возможностями API, чтобы добиться различных сценариев и бизнес-процессов.

Доступные вебхуки

Действие 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
Проекты. Удалить проект 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, slave_id
Проекты. Закрыть задачу id, project_id
Проекты. Перенести задачу id, project_id, deadline
Проекты. Удалить задачу id, project_id
Проекты. Добавить продукт id, project_id, good_id, comment
Проекты. Удалить продукт id, project_id
Проекты. Изменить этап id, project_id, step_id, comment
Проекты. Добавить платёж id, project_id, payment_date, price, currency_id, name, expense
Проекты. Удалить платёж id, project_id
Проекты. Добавить счёт id, project_id, invoice_number, invoice_date
Проекты. Удалить счёт id, project_id
Лизинг. Добавить график платежей project_id
Лизинг. Добавить участника project_id, type_id, client_id
Лизинг. Удалить участника id, project_id
Группы проектов. Добавить группу id, name, comment
Группы проектов. Редактировать группу id, name, comment
Группы проектов. Удалить группу id
Лиды. Добавить лид 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, repeat_times, all_day, todo_id, project_id
Календарь. Редактировать событие 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, phone_1, phone_2, email_1, email_2, position, bday, comment
Контакты. Редактировать контакт id, client_id, name, phone_1, phone_2, email_1, email_2, position, 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
Cloud. Редактировать файл id, category_id, name
Cloud. Обновить файл id
Cloud. Удалить файл id
Финансы. Привязать платёж id, project_id
Группы пользователей. Добавить группу id, name, comment
Группы пользователей. Редактировать группу id, name, comment
Группы пользователей. Права доступа группы id
Группы пользователей. Удалить группу id
Пользователи. Добавить пользователя id, login, surname, name, patronymic, initials, phone, internal_number, pushkey, active
Пользователи. Редактировать пользователя id, login, surname, name, patronymic, initials, phone, internal_number, pushkey, active
Пользователи. Изменить пароль user_id
Пользователи. Права доступа user_id
Пользователи. Передать данные projects, project_todos, project_groups, leads, lead_todos, calendar, clients, contacts, reports, catalog, cloud, user_groups, users, user_id
Пользователи. Доступ к API user_id
Пользователи. Авторизация
Пользователи. Выход из системы
Выгрузка данных. Проекты
Выгрузка данных. Лиды
Выгрузка данных. Календарь
Выгрузка данных. Контрагенты
Выгрузка данных. Контакты

Вместе с указанными выше полями Body, также отправляются служебные данные:

Остались вопросы? Обращайтесь в службу поддержки по адресу электронной почты s@solos.pro