Входящие вебхуки: различия между версиями
Artem (обсуждение | вклад) Нет описания правки |
Artem (обсуждение | вклад) Нет описания правки |
||
Строка 25: | Строка 25: | ||
Для того, чтобы понять как работают вебхуки, давайте сформируем ссылку, которая будет создавать новые задачи в ПланФиксе: | Для того, чтобы понять как работают вебхуки, давайте сформируем ссылку, которая будет создавать новые задачи в ПланФиксе: | ||
*На первом шаге выберите тип запроса, который будет использоваться в ссылке — GET или POST. Для примера выберу GET-запрос | *На первом шаге выберите тип запроса, который будет использоваться в ссылке — GET или POST. Для примера выберу GET-запрос: | ||
https://p.pfx.so/pf/IE/BETP4r.png | https://p.pfx.so/pf/IE/BETP4r.png | ||
Строка 35: | Строка 35: | ||
*На следующем шаге добавляем к вебхуку параметры. В них будут хранится значения, которые пользователь передает в ПланФикс. В примере мы передаём название проекта и название задачи | *На следующем шаге добавляем к вебхуку параметры. В них будут хранится значения, которые пользователь передает в ПланФикс. В примере мы передаём название проекта и название задачи: | ||
https://p.pfx.so/pf/CT/caY3Qq.png | https://p.pfx.so/pf/CT/caY3Qq.png | ||
*Указываем от чьего имени будет выполнятся действие в ПланФиксе после того, как сработает вебхук: | |||
* | |||
https://p.pfx.so/pf/MC/hRGKxF.png | https://p.pfx.so/pf/MC/hRGKxF.png | ||
*''' | *Выбираем тип операции и настраиваем его. В итоге ПланФикс должен создать задачу по выбранному шаблону, в поле задачи '''Проект''' положить значение из параметра ссылки '''project''', а в поле задачи '''Название''' положить значение из параметра ссылки '''name''', затем к созданной задаче добавить указанного исполнителя: | ||
https://p.pfx.so/pf/ | https://p.pfx.so/pf/sI/GNcuHj.png | ||
* | *Далее добавляем дополнительные операции при необходимости: | ||
https://p.pfx.so/pf/ | https://p.pfx.so/pf/ZL/mOEm3P.png | ||
* | *И в завершении указываем, какой ответ от вебхука хотим получить — JSON, переход на страницу ПланФикса или своего сайта: | ||
https://p.pfx.so/pf/w6/s6CIfK.png | https://p.pfx.so/pf/w6/s6CIfK.png |
Версия от 15:43, 12 февраля 2021
Входящие вебхуки — это специальная ссылка, которая позволяет создавать и изменять задачи или добавлять контакты в ПланФикс по специальной ссылке. Она формируется из определенного типа и параметров:
https://ваш_аккаунт.planfix.ru/webhook/get/htnh-4w03-vojf-pjpu?project=проект&name=название задачи
Когда по такой ссылке переходит клиент или другой внешний пользователь, в ПланФиксе автоматически запускаются заранее настроенные операции. Это простой способ связать ПланФикс с другим веб-сервисом или собственной программой.
Вебхуки добавляются в ПланФикс в разделе Управление аккаунтом — Входящие вебхуки:
По кнопке Новый вебхук можно выбрать предустановленные настройки или добавить самостоятельно настроенный вебхук:
Формирование вебхука
Для того, чтобы понять как работают вебхуки, давайте сформируем ссылку, которая будет создавать новые задачи в ПланФиксе:
- На первом шаге выберите тип запроса, который будет использоваться в ссылке — GET или POST. Для примера выберу GET-запрос:
- Вебхук можно уникализировать, добавив свои значения в специальное поле:
- На следующем шаге добавляем к вебхуку параметры. В них будут хранится значения, которые пользователь передает в ПланФикс. В примере мы передаём название проекта и название задачи:
- Указываем от чьего имени будет выполнятся действие в ПланФиксе после того, как сработает вебхук:
- Выбираем тип операции и настраиваем его. В итоге ПланФикс должен создать задачу по выбранному шаблону, в поле задачи Проект положить значение из параметра ссылки project, а в поле задачи Название положить значение из параметра ссылки name, затем к созданной задаче добавить указанного исполнителя:
- Далее добавляем дополнительные операции при необходимости:
- И в завершении указываем, какой ответ от вебхука хотим получить — JSON, переход на страницу ПланФикса или своего сайта:
Пример использования
Настроим автоматическое создание контактов в ПланФиксе из формы обратной связи на сайте. Для этого:
- Формируем ссылку вебхука. Для отправки формы нужен вебхук с POST-запросом:
https://planfix.ru/webhook/POST/fd12-4545-fzdf-df75
- Добавляем вебхук в код формы обратной связи:
<form method="post" action="https://planfix.ru/webhook/POST/fd12-4545-fzdf-df75"> <p><input type="text" name="name" placeholder="Имя"></p> <p><input type="text" name="phone" placeholder="Телефон"></p> <p><input type="submit" name="submit" value="Отправить"></p> </form>
Теперь каждый раз, когда клиенты будут заполнять форму обратной связи на сайте, в ПланФиксе будет автоматически создаваться контакт.