Входящие вебхуки: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
Строка 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




 
*Указываем от чьего имени будет выполнятся действие в ПланФиксе после того, как сработает вебхук:
 
 
 
*'''Шаг 2:''' извлекаем данные из вебхука — называем инфоблоки, входящие параметры и какие значения сохранить:
 
https://p.pfx.so/pf/vl/ADS9pX.png
 
 
*'''Шаг 3:''' Указываем от чьего имени будет выполнятся действие в ПланФиксе после срабатывания вебхука:


https://p.pfx.so/pf/MC/hRGKxF.png
https://p.pfx.so/pf/MC/hRGKxF.png




*'''Шаг 4:''' Выбираем тип операции — создать или изменить задачу, создать контакт:
*Выбираем тип операции и настраиваем его. В итоге ПланФикс должен создать задачу по выбранному шаблону, в поле задачи '''Проект''' положить значение из параметра ссылки '''project''', а в поле задачи '''Название''' положить значение из параметра ссылки '''name''', затем к созданной задаче добавить указанного исполнителя:


https://p.pfx.so/pf/BP/5sXNus.png
https://p.pfx.so/pf/sI/GNcuHj.png




*'''Шаг 5:''' Добавляем дополнительные операции при необходимости:
*Далее добавляем дополнительные операции при необходимости:


https://p.pfx.so/pf/Y5/iFRW2k.png
https://p.pfx.so/pf/ZL/mOEm3P.png




*'''Шаг 6:''' Указываем какой ответ от вебхука хотим получить — JSON, переход на страницу ПланФикса или своего сайта:
*И в завершении указываем, какой ответ от вебхука хотим получить — 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=название задачи

Когда по такой ссылке переходит клиент или другой внешний пользователь, в ПланФиксе автоматически запускаются заранее настроенные операции. Это простой способ связать ПланФикс с другим веб-сервисом или собственной программой.

Вебхуки добавляются в ПланФикс в разделе Управление аккаунтомВходящие вебхуки:

h4w1Vq.png


По кнопке Новый вебхук можно выбрать предустановленные настройки или добавить самостоятельно настроенный вебхук:

c7SjWC.png


Формирование вебхука

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

  • На первом шаге выберите тип запроса, который будет использоваться в ссылке — GET или POST. Для примера выберу GET-запрос:

BETP4r.png


  • Вебхук можно уникализировать, добавив свои значения в специальное поле:

QcE5WA.png


  • На следующем шаге добавляем к вебхуку параметры. В них будут хранится значения, которые пользователь передает в ПланФикс. В примере мы передаём название проекта и название задачи:

caY3Qq.png


  • Указываем от чьего имени будет выполнятся действие в ПланФиксе после того, как сработает вебхук:

hRGKxF.png


  • Выбираем тип операции и настраиваем его. В итоге ПланФикс должен создать задачу по выбранному шаблону, в поле задачи Проект положить значение из параметра ссылки project, а в поле задачи Название положить значение из параметра ссылки name, затем к созданной задаче добавить указанного исполнителя:

GNcuHj.png


  • Далее добавляем дополнительные операции при необходимости:

mOEm3P.png


  • И в завершении указываем, какой ответ от вебхука хотим получить — JSON, переход на страницу ПланФикса или своего сайта:

s6CIfK.png


Пример использования

Настроим автоматическое создание контактов в ПланФиксе из формы обратной связи на сайте. Для этого:

  • Формируем ссылку вебхука. Для отправки формы нужен вебхук с 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>


Теперь каждый раз, когда клиенты будут заполнять форму обратной связи на сайте, в ПланФиксе будет автоматически создаваться контакт.

Перейти