Входящие вебхуки

Материал из Planfix
Перейти к: навигация, поиск

Входящие вебхуки — это специальная ссылка, которая позволяет создавать и изменять задачи или добавлять контакты в ПланФикс. Она формируется из определенного типа и параметров.

Пример вебхука:

https://ваш_аккаунт.planfix.ru/webhook/get/create_task?project=проект&name=название задачи


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

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

h4w1Vq.png


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

c7SjWC.png


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


Формирование вебхука с GET-запросом

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

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

BETP4r.png


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

A2aDET.png


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

X21MgH.png


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

hRGKxF.png


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

GNcuHj.png


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

mOEm3P.png


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

2B94qS.png


Теперь, используя этот вебхук, можно быстро создавать новые задачи в нужном проекте прямо в адресной строке браузера:

  • Копируем ссылку созданного вебхука и добавляем в адресную строку браузера:
https://ваш_аккаунт.planfix.ru/webhook/get/create_task?project=укажите&name=укажите


  • Затем указываем нужные значения и переходим по ссылке:
https://ваш_аккаунт.planfix.ru/webhook/get/create_task?project=SEO&name=Анализ конкурентов


  • В итоге в ПланФиксе появилась новая задача:

eubqkO.png


Важно

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


Использование вебхука с POST-запросом

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

  • Для отправки формы нужен вебхук с POST-запросом:
https://ваш_аккаунт.planfix.ru/webhook/POST/create_contact

EaeJVs.png


  • Добавляем вебхук в код формы обратной связи на сайте:

<form method="post" action="https://ваш_аккаунт.planfix.ru/webhook/POST/create_contact">
  <input type="text" name="name" placeholder="Имя">
  <input type="text" name="phone" placeholder="Телефон">
  <input type="submit" name="submit" value="Отправить">
</form>


  • Когда клиент заполнит в форме обратной связи имя и телефон, а затем кликнет на кнопку Отправить:

xorhzH.png


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

KPIrAJ.png


Перейти