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

Текущая версия от 12:39, 16 июля 2024

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

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

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

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

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

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

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

Дополнительная информация

Важно

Входящие вебхуки возвращают JSON с номером созданной задачи (2) только из основной операции (1):

@@ Строка 2: / Строка 2: @@
 |title=Входящие вебхуки в ПланФиксе
 |titlemode=append
-|keywords=планфикс, автоматизация, интеграция, входящие вебхуки, webhook
+|keywords=планфикс, автоматизация, интеграция, входящие вебхуки, webhook, вебхук
 |description=Входящие вебхуки в ПланФиксе
 }}
-'''Входящие вебхуки''' позволяют создавать и изменять задачи или добавлять контакты в ПланФикс по специальной ссылке.
+'''Входящие вебхуки''' — это специальная ссылка, которая позволяет создавать и изменять задачи или добавлять контакты в ПланФикс. Она формируется из определенного типа и параметров.
- <nowiki>https://ваш_аккаунт.planfix.ru/webhook/get/htnh-4w03-vojf-pjpu?</nowiki><span style="color:red;">project</span>=проект&<span style="color:green;">name</span>=название задачи
+Пример вебхука:
-Она формируется из определенных параметров, и когда по ссылке переходит клиент или другой внешний пользователь, в ПланФиксе автоматически запускаются заранее настроенные операции. Это простой способ связать ПланФикс с другим веб-сервисом или собственной программой.
+ <nowiki>https://</nowiki>ваш_аккаунт.planfix.ru/<span style="color:red;">webhook/get/create_task</span>?<span style="color:green;">project</span>=проект&<span style="color:green;">name</span>=название задачи
+Когда по такой ссылке переходит клиент или другой внешний пользователь, в ПланФиксе автоматически запускаются заранее настроенные операции. Это простой способ связать ПланФикс с другим веб-сервисом или собственной программой.
 Вебхуки добавляются в ПланФикс в разделе '''Управление аккаунтом''' — '''Входящие вебхуки''':
@@ Строка 17: / Строка 20: @@
-По кнопке '''Новый вебхук''' можно выбрать предустановленные настройки или добавить самостоятельно настроенный вебхук:
+По кнопке '''Новый вебхук''' можно выбрать один из предустановленных вариантов настройки или добавить самостоятельно настроенный вебхук:
 https://p.pfx.so/pf/aW/c7SjWC.png
-== Формирование вебхука ==
+== Примеры использования ==
-Формируется вебхук за 6 шагов. С некоторыми шагами вы могли сталкиваться при настройке [[Автоматические сценарии |автоматических сценариев]]:
+*[[Вебхук с GET-запросом]]
+*[[Вебхук с POST-запросом]]
-*'''Шаг 1:''' выбираем тип запроса — GET или POST.
+*[[Вебхук принимает данные из Jenkins]]
-*'''Шаг 2:''' извлекаем данные из вебхука — называем инфоблоки, входящие параметры и какие значения сохранить:
-https://p.pfx.so/pf/vl/ADS9pX.png
-*'''Шаг 3:''' Указываем от чьего имени будет выполнятся действие в ПланФиксе после срабатывания вебхука:
-https://p.pfx.so/pf/MC/hRGKxF.png
-*'''Шаг 4:''' Выбираем тип операции — создать или изменить задачу, создать контакт:
-https://p.pfx.so/pf/BP/5sXNus.png
-*'''Шаг 5:''' Добавляем дополнительные операции при необходимости:
-https://p.pfx.so/pf/Y5/iFRW2k.png
-*'''Шаг 6:''' Указываем какой ответ от вебхука хотим получить — JSON, переход на страницу ПланФикса или своего сайта:
-https://p.pfx.so/pf/w6/s6CIfK.png
-== Пример использования ==
-Настроим автоматическое создание контактов в ПланФиксе из формы обратной связи на сайте. Для этого:
-*Формируем ссылку вебхука. Для отправки формы нужен вебхук с POST-запросом:
- <nowiki>https://planfix.ru/webhook/POST/fd12-4545-fzdf-df75</nowiki>
-*Добавляем вебхук в код формы обратной связи:
+== Дополнительная информация ==
+*[https://planfix.com/ru/blog/vhodyashchie-vebhuki-poluchaem-dannye-v-planfiks-bez-promedleniya/ Входящие вебхуки: получаем данные в ПланФикс без промедления]
+*[https://planfix.ru/docs/JSONPath Приходящие в ПланФикс вебхуки можно разбирать, используя JSON. Для этого используется библиотека JsonPath]
+*[https://planfix.com/ru/blog/kak-otpravlyat-zakazy-iz-tildy-v-planfiks/ Как отправлять заказы из Тильды в ПланФикс]
-<pre><form method="post" action="<nowiki>https://planfix.ru/webhook/POST/fd12-4545-fzdf-df75</nowiki>">
+==  Важно ==
-   <p><input type="text" name="name" placeholder="Имя"></p>
+*Входящие вебхуки возвращают JSON с номером созданной задачи (2) только из основной операции (1):
-   <p><input type="text" name="phone" placeholder="Телефон"></p>
-   <p><input type="submit" name="submit" value="Отправить"></p>
-</form></pre>
+https://p.pfx.so/pf/pZ/Zqzn7c.png
-Теперь каждый раз, когда клиенты будут заполнять форму обратной связи на сайте, в ПланФиксе будет автоматически создаваться контакт.
 == Перейти ==
+*[[HTTP-запросы]]
 *[[Описание возможностей]]

Навигация

Перейти