Обработка входящих вебхуков
Типы вебхуков
Благодаря механизму вебхуков разные приложения могут передавать данные друг другу по уникальному URL.
В приложении интеграции при помощи вебхуков вы можете настроить передачу данных о переходе сделки из одного этапа в другой, а также выбрать какое действие должно выполняться, когда совершается такой переход.
Важно! Настройка доступна только для расширенного пакета интеграции и только на соответствующих версиях Битрикс24.
В приложении интеграции обрабатываются несколько типов входящих вебхуков, см. таблицу ниже:
| Тип входящего вебхука | Общее описание |
|---|---|
| Автоперезвон через вебхук | При изменении в воронке продаж Битрикс24 приложение интеграции инициирует исходящий звонок Клиенту от имени вашего сотрудника. |
| Автопостановка задания в кампанию исходящего обзвона при изменении воронке продаж. Интеграция с Контакт-центром MANGO OFFICE через вебхуки | Если вы подключили Контакт-центр MANGO OFFICE к вашей Виртуальной АТС, то при помощи вебхуков вы можете автоматически добавлять задания в кампанию исходящего обзвона при изменении в воронке продаж Битрикс24. |
| Перемещение сделок в Битрикс24 через вебхук | Вы можете настроить правила автоматического перемещения сделки на основе параметров, в которых указано название этапа, на который нужно перенести сделку, соответствующую конкретному значению. |
Автоперезвон через вебхук
Обзор
Включите данную функцию, чтобы получить возможность автоматически перезванивать Клиенту при переходе сделки из одного этапа воронки в другой этап воронки. Подробнее о том, как работает автоперезвон через вебхук:
- Когда сделка переходит из одного этапа в другой, робот Битрикс24 отправит в приложение интеграции соответствующий вебхук;
- В результате обработки входящего вебхука, приложение интеграции инициирует звонок. При этом, сначала зазвонит рабочий телефон сотрудника, и только после того как сотрудник примет вызов, начнется звонок Клиенту.
Настроить и использовать автоперезвон через вебхук просто. Для этого нужно:
- В настройках интеграции включить функцию и скопировать уникальный URL-адрес вебхуков, и сохранить его к себе (например, в блокнот);
- Настроить робота Битрикс24 на отправку вебхуков в приложение интеграции.
Как включить автоперезвон через вебхук
В настройках интеграции MANGO OFFICE в блоке «Остальное», выполните следующие действия:
- Активируйте переключатель «Обрабатывать входящие вебхуки». Появятся дополнительные поля, в которых перечислены все входящие вебхуки;
- Активируйте переключатель «Автоперезвон через вебхук»;
- Нажмите на ссылку «Скопировать» в строке с данными вебхуков, чтобы скопировать URL-адрес вебхуков. Сохраните полученный URL (например, в блокнот);
- Сохраните настройки интеграции, нажав на кнопку «Применить» (расположена внизу окна настроек интеграции MANGO OFFICE).
Примечание. Теперь вам нужно настроить робота Битрикс24 на отправку вебхуков в приложение интеграции.
Перемещение сделок в Битрикс24 через вебхук
Общее
Приложение интеграции позволяет автоматически переместить определенную сделку (одну или несколько) на определенный этап воронки продаж в Битрикс24 по команде из внешней (по отношению к Виртуальной АТС и Битрикс24) системы.
Принцип действия:
- После настройки вебхука перемещения сделки, внешняя система передает по информационной сети специальный вебхук на специальный URL-адрес. Этот вебхук содержит данные для перемещения сделки;
- На основании данных, полученных из вебхука, приложение интеграции формирует и отправляет в Битрикс24 запрос на перемещение определенной сделки на определенный этап воронки продаж.
Порядок настройки вебхука перемещения сделок:
| Действие | Пояснение |
|---|---|
| 1) Настройка вебхука в приложении интеграции Битрикс24 | В настройках приложения интеграции вы:
|
| 2) Добавление URL-адреса вебхука во внешнюю систему | Вы добавляете в настройки вашей внешней системы полученный вами URL-адрес вебхука. Для этого следует привлечь вашего программиста. |
Настройка вебхука в приложении интеграции Битрикс24
Для этого, в форме настройки приложения интеграции в блоке «Остальное» необходимо:
- Активировать переключатель «Перемещение сделок в Битрикс24 через вебхук». В форме настройки приложения появится поле, содержащее URL-адрес вебхука, и таблица «Условия перемещения сделок»;
- В таблице «Условия перемещения сделок» будут перечислены все воронки продаж, имеющиеся в вашем Битрикс24. Вам нужно найти строку с названием воронки продаж, внутри которой будет перемещаться сделка, и в этой строке настроить правило перемещения сделки.
Чтобы настроить правило перемещения сделки, необходимо:
- В таблице найти строку с названием воронки продаж, внутри которой будет перемещаться сделка;
- Если ваша внешняя система будет передавать в приложение интеграции вебхук с параметром «Result=POSITIVE», то в раскрывающемся списке столбца «Успешно» выберите название этапа, в который должна быть перемещена сделка;
- Если ваша внешняя система будет передавать в приложение интеграции вебхук с параметром «Result=NEGATIVE», то в раскрывающемся списке столбца «Ошибка» выберите название этапа, в который должна быть перемещена сделка;
- Если ваша внешняя система будет передавать в приложение интеграции вебхук с параметром «Result=NEUTRAL», то в раскрывающемся списке столбца «Нейтрально» выберите название этапа, в который должна быть перемещена сделка.
Примечания:
- Вы можете настроить правило перемещения сделок для одной, нескольких или всех воронок, указанных в таблице «Условия перемещения сделок»;
- В результате настройки правила перемещения сделки, будет изменена структура URL-адреса вебхука.
3) Нажмите кнопку «Скопировать», чтобы скопировать URL-адрес вебхука. Сохраните полученный URL, например, в Блокнот;
4) Нажмите на кнопку «Применить» в нижней части формы настройки приложения интеграции и переходите к добавлению во внешнюю систему URL-адреса вебхука перемещения сделок.
Добавление во внешнюю систему URL-адреса вебхука перемещения сделок. Общие требования:
- Полученный вами URL-адрес вебхука перемещения сделок нужно добавить в вашу внешнюю систему. Для этого привлеките вашего специалиста, имеющего навыки администрирования вашей системы;
- Для обеспечения корректной обработки вебхука перемещения сделок внешняя система должна обеспечивать:
- поддерживать передачу данных по протоколу HTTP;
- обеспечивать подстановку в следующие параметры URL-адреса вебхука перемещения сделок значений, соответствующих следующим требованиям:
| Параметр URL-адреса вебхука | Требование |
|---|---|
| DealID | Внешняя система должна обеспечивать подстановку в параметр «DealID» внутреннего ID-номера сделки, выданного Битрикс24 (по этому номеру приложение интеграции определит какую сделку нужно переместить). При записи внутреннего номера телефона нужно использовать только арабские цифры от 0 до 9. |
| Result | Внешняя система должна обеспечивать подстановку в параметр «Result» одного из следующих значений: POSITIVE, NEGATIVE, NEUTRAL. Примечание. Подстановка других значений в параметр «Result» запрещена. |
Примеры:
- Не корректный URL-адрес вебхука: подстановка не корректного значения в параметр «Result»:
https://integration-webhook.mango-office.ru/webhookapp/?Source=Bitrix24&AuthData=qwerty&Product_id=qwerty.bitrix24.ru&Action=Deal_Move&DealID=12&Result=HELLO
- Пример корректного URL-адреса вебхука:
https://integration-webhook.mango-office.ru/webhookapp/?Source=Bitrix24&AuthData=qwerty2&Product_id=qwerty.bitrix24.ru&Action=Deal_Move&DealID=12&Result=POSITIVE
Описание параметров вебхука
В URL-адресе вебхука есть 2 обязательных параметра:
- DealID. ID-номер, присвоенный сделке в Битрикс24;
- Result. Определяет этап воронки, на который нужно перенести сделку, соответствующую конкретному значению.
DealID
В параметре указывается ID-номер сделки, которую надо переместить внутри воронки продаж. Пример. Вебхук перемещения сделки, где параметру DealID присвоено значение 12:
https://integration-webhook.mango-office.ru/webhookapp/?Source=Bitrix24&AuthData=qwerty2&Product_id=qwerty.bitrix24.ru&Action=Deal_Move&DealID=12&Result=POSITIVE
Result
Этот параметр используется, чтобы определить этап воронки, в который надо перенести сделку. Этому параметру может быть присвоено только одно из следующих значений:
- POSITIVE
Описание: соответствует столбцу «Успешно» в таблице «Условия перемещения сделок».
Принцип действия: Если в таблице «Условия перемещения сделок» в столбце «Успешно» указано название этапа воронки продаж, и внешняя система передала в приложение интеграции вебхук перемещения сделки, в котором параметру Result присвоено значение POSITIVE, то сделка, указанная в вебхуке, будет перенесена в этап, указанный в столбце «Успешно» таблицы «Условия перемещения сделок».
Пример правила. Вы указали этап «Подготовка документов» в столбце «Успешно» таблицы «Условия перемещения сделок». Тогда URL-адрес вебхука перемещения сделки будет примерно таким:
https://integration-webhook.mango-office.ru/webhookapp/?Source=Bitrix24&AuthData=qwerty&Product_id=qwerty.bitrix24.ru&Action=Deal_Move&DealID=12&Result=POSITIVE
Если внешняя система отправит вебхук на этот URL-адрес, то в Битрикс24 будет автоматически перемещена сделка с ID-номером 12 в воронку «Подготовка документов».
- NEGATIVE
Описание: соответствует столбцу «Ошибка» в таблице «Условия перемещения сделок».
Принцип действия: Если в таблице «Условия перемещения сделок» в столбце «Ошибка» указано название этапа воронки продаж, и внешняя система передала в приложение интеграции вебхук перемещения сделки, в котором параметру Result присвоено значение NEGATIVE, то сделка, указанная в вебхуке, будет перенесена в этап, указанный в столбце «Ошибка» таблицы «Условия перемещения сделок».
Пример правила. Вы указали этап «Подготовка документов» в столбце «Ошибка» таблицы «Условия перемещения сделок». Тогда URL-адрес вебхука перемещения сделки будет примерно таким:
https://integration-webhook.mango-office.ru/webhookapp/?Source=Bitrix24&AuthData=qwerty&Product_id=qwerty.bitrix24.ru&Action=Deal_Move&DealID=12&Result=NEGATIVE
Если внешняя система отправит вебхук на этот URL-адрес, то в Битрикс24 будет автоматически перемещена сделка с ID-номером 12 в воронку «Подготовка документов».
- NEUTRAL
Описание: соответствует столбцу «Нейтрально» в таблице «Условия перемещения сделок».
Принцип действия: Если в таблице «Условия перемещения сделок» в столбце «Нейтрально» указано название этапа воронки продаж, и внешняя система передала в приложение интеграции вебхук перемещения сделки, в котором параметру Result присвоено значение NEUTRAL, то сделка, указанная в вебхуке, будет перенесена в этап, указанный в столбце «Нейтрально» таблицы «Условия перемещения сделок».
Пример правила. Вы указали этап «Подготовка документов» в столбце «Нейтрально» таблицы «Условия перемещения сделок». Тогда URL-адрес вебхука перемещения сделки будет примерно таким:
https://integration-webhook.mango-office.ru/webhookapp/?Source=Bitrix24&AuthData=qwerty&Product_id=qwerty.bitrix24.ru&Action=Deal_Move&DealID=12&Result=NEUTRAL
Если внешняя система отправит вебхук на этот URL-адрес, то в Битрикс24 будет автоматически перемещена сделка с ID-номером 12 в воронку «Подготовка документов».
Важно! Записывать значение параметра Result нужно всегда большими латинскими буквами.
