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

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
 
(не показано 126 промежуточных версий этого же участника)
Строка 2: Строка 2:
|title=Входящие вебхуки в ПланФиксе
|title=Входящие вебхуки в ПланФиксе
|titlemode=append
|titlemode=append
|keywords=планфикс, автоматизация, интеграция, входящие вебхуки, webhook
|keywords=планфикс, автоматизация, интеграция, входящие вебхуки, webhook, вебхук
|description=Входящие вебхуки в ПланФиксе
|description=Входящие вебхуки в ПланФиксе
}}
}}


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


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


https://p.pfx.so/pf/ht/Iwbx21.png
<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>=название задачи




В разделе отображаются название, метод запроса и url вебхуков. По кнопке '''Новый вебхук''' можно выбрать предустановленные настройки или добавить самостоятельно настроенный вебхук:
Когда по такой ссылке переходит клиент или другой внешний пользователь, в ПланФиксе автоматически запускаются заранее настроенные операции. Это простой способ связать ПланФикс с другим веб-сервисом или собственной программой.
 
Вебхуки добавляются в ПланФикс в разделе '''Управление аккаунтом''' — '''Входящие вебхуки''':
 
https://p.pfx.so/pf/Jj/h4w1Vq.png
 
 
По кнопке '''Новый вебхук''' можно выбрать один из предустановленных вариантов настройки или добавить самостоятельно настроенный вебхук:


https://p.pfx.so/pf/aW/c7SjWC.png
https://p.pfx.so/pf/aW/c7SjWC.png




== Формирование вебхука ==
== Примеры использования ==
Формируется вебхук за 6 шагов. С некоторыми шагами вы могли сталкиваться при настройке [Автоматические сценарии |автоматического сценария].
*[[Вебхук с GET-запросом]]
*[[Вебхук с POST-запросом]]
*[[Вебхук принимает данные из Jenkins]]
 
 
== Дополнительная информация ==
*[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/ Как отправлять заказы из Тильды в ПланФикс]
 
==  Важно ==
*Входящие вебхуки возвращают JSON с номером созданной задачи (2) только из основной операции (1):
 
https://p.pfx.so/pf/pZ/Zqzn7c.png


'''ШАГ № 1: Тип вебхука'''
На первом шаге выберите тип запроса:
*'''Get'''-запрос —
*'''POST'''-запрос —


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

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

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

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

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


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

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

h4w1Vq.png


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

c7SjWC.png


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


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

Важно

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

Zqzn7c.png


Перейти