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

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
Строка 28: Строка 28:
*[[Вебхук с GET-запросом]]
*[[Вебхук с GET-запросом]]
*[[Вебхук с POST-запросом]]
*[[Вебхук с POST-запросом]]
== Формирование вебхука с GET-запросом ==
Для того, чтобы понять как работают вебхуки, сформируем ссылку, которая будет создавать новые задачи в ПланФиксе:
*На первом шаге выберите тип запроса, который будет использоваться в ссылке — GET или POST. Для примера  GET-запрос:
https://p.pfx.so/pf/IE/BETP4r.png
*Вебхук можно уникализировать, добавив свои значения в специальное поле:
https://p.pfx.so/pf/G2/A2aDET.png
*На следующем шаге добавляем к вебхуку параметры. В них будут хранится значения, которые пользователь передает в ПланФикс. В примере мы передаём название проекта и название задачи:
https://p.pfx.so/pf/b1/X21MgH.png
*Указываем от чьего имени будет выполнятся действие в ПланФиксе после того, как сработает вебхук:
https://p.pfx.so/pf/MC/hRGKxF.png
*Выбираем тип операции и настраиваем его. В итоге ПланФикс должен создать задачу по выбранному шаблону, добавить название проекта из параметра ссылки '''project''' и название задачи из параметра ссылки '''name''', затем к задаче добавить указанного исполнителя:
https://p.pfx.so/pf/sI/GNcuHj.png
*Далее добавляем дополнительные операции при необходимости:
https://p.pfx.so/pf/ZL/mOEm3P.png
*И на последнем шаге указываем, какой ответ от вебхука хотим получить — JSON, переход на страницу ПланФикса или личного сайта:
https://p.pfx.so/pf/Ya/2B94qS.png
Теперь, используя этот вебхук, можно быстро создавать новые задачи в нужном проекте прямо в адресной строке браузера:
*Копируем ссылку созданного вебхука и добавляем в адресную строку браузера:
<nowiki>https://</nowiki>ваш_аккаунт.planfix.ru/webhook/get/create_task?<span style="color:green;">project</span>=<span style="color:red;">укажите</span>&<span style="color:green;">name</span>=<span style="color:red;">укажите</span>
*Затем указываем нужные значения и переходим по ссылке:
<nowiki>https://</nowiki>ваш_аккаунт.planfix.ru/webhook/get/create_task?<span style="color:green;">project</span>=<span style="color:red;">SEO</span>&<span style="color:green;">name</span>=<span style="color:red;">Анализ конкурентов</span>
*В итоге в ПланФиксе появилась новая задача:
https://p.pfx.so/pf/Fz/eubqkO.png
== Важно ==
Добавление значений в параметры ссылки вебхука можно и нужно автоматизировать, применяя различные [[Переменные в шаблонах задач |переменные]].
== Использование вебхука с POST-запросом ==
Автоматизацию заполнения значений параметров ссылки вебхука рассмотрим на примере формы обратной связи на сайте. Для этого в ПланФиксе настроим вебхук, который будет создавать контакты:
*Для отправки формы нужен вебхук с POST-запросом:
<nowiki>https://</nowiki>ваш_аккаунт.planfix.ru/webhook/<span style="color:green;">POST</span>/create_contact
https://p.pfx.so/pf/Tp/EaeJVs.png
*Добавляем вебхук в код формы обратной связи на сайте:
<div style="width:100%; margin: 0 0 10px; font-size: 13px; line-height: 1.65; word-break: break-all; color: black; background-color: #f9f9f9; border: 1px solid #ddd; padding: 1em 1em 0px 1em; font-family:monospace,Courier; border-radius: 4px;">
<form method="post" action="<nowiki>https://</nowiki>ваш_аккаунт.planfix.ru/webhook/POST/create_contact"><br>
&nbsp;&nbsp;<input type="text" name="<span style="color:green;">name</span>" placeholder="<span style="color:red;">Имя</span>"><br>
&nbsp;&nbsp;<input type="text" name="<span style="color:green;">phone</span>" placeholder="<span style="color:red;">Телефон</span>"><br>
&nbsp;&nbsp;<input type="submit" name="submit" value="Отправить"><br>
</form>
</div>
*Когда клиент заполнит в форме обратной связи '''имя''' и '''телефон''', а затем кликнет на кнопку '''Отправить''':
https://p.pfx.so/pf/Fk/xorhzH.png
*Значения из полей формы добавятся в вебхук и отправятся в ПланФикс, где автоматически создастся новый контакт:
https://p.pfx.so/pf/hS/KPIrAJ.png




== Перейти ==
== Перейти ==
*[[Описание возможностей]]
*[[Описание возможностей]]

Версия от 13:45, 15 февраля 2021

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

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

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


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

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

h4w1Vq.png


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

c7SjWC.png


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


Перейти