Incoming webhooks: Difference between revisions
From Planfix
No edit summary |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
'''Incoming webhooks''' are special links that let you create or modify tasks or add contacts to Planfix. They are created using a specific type and parameters. | '''Incoming webhooks''' are special links that let you create or modify tasks or add contacts to Planfix. They are created using a specific type and parameters. | ||
Webhook sample: | |||
<div style="display: block; padding: 1em; margin: 0 0 10px; font-size: 13px; line-height: 1.65; color: black; word-wrap: break-word; background-color: #f9f9f9; border: 1px solid #ddd; border-radius: 4px;">https://your_account.planfix.ru/<span style="color:red;">webhook/get/create_task</span>?<span style="color:green;">project</span>=project&<span style="color:green;">name</span>=taskname</div> | <div style="display: block; padding: 1em; margin: 0 0 10px; font-size: 13px; line-height: 1.65; color: black; word-wrap: break-word; background-color: #f9f9f9; border: 1px solid #ddd; border-radius: 4px;"><nowiki>https://</nowiki>your_account.planfix.ru/<span style="color:red;">webhook/get/create_task</span>?<span style="color:green;">project</span>=project&<span style="color:green;">name</span>=taskname</div> | ||
When a client or other external user clicks this link, predefined operations launch in Planfix. This is a simple way to link Planfix with another web service or program. | When a client or other external user clicks this link, predefined operations launch in Planfix. This is a simple way to link Planfix with another web service or program. | ||
| Line 17: | Line 16: | ||
https://s.pfx.so/pf/aH/bibPsi.png | https://s.pfx.so/pf/aH/bibPsi.png | ||
When you click the '''New Webhook''' button, you can select one of the preset configuration options or configure your own webhook: | When you click the '''New Webhook''' button, you can select one of the preset configuration options or configure your own webhook: | ||
https://s.pfx.so/pf/vi/xSs3vB.png | https://s.pfx.so/pf/vi/xSs3vB.png | ||
== Examples == | == Examples == | ||
*[[Webhooks with GET requests]] | *[[Webhooks with GET requests]] | ||
*[[Webhooks with POST requests]] | *[[Webhooks with POST requests]] | ||
*[[Webhook receives data from Jenkins]] | |||
== Important == | == Important == | ||
Incoming webhooks only return JSON with the created task number (2) from the main action (1): | Incoming webhooks only return JSON with the created task number (2) from the main action (1): | ||
Latest revision as of 12:47, 22 November 2024
Incoming webhooks are special links that let you create or modify tasks or add contacts to Planfix. They are created using a specific type and parameters.
Webhook sample:
https://your_account.planfix.ru/webhook/get/create_task?project=project&name=taskname
When a client or other external user clicks this link, predefined operations launch in Planfix. This is a simple way to link Planfix with another web service or program.
Webhooks can be added to Planfix in the Account management — Incoming webhooks section:
When you click the New Webhook button, you can select one of the preset configuration options or configure your own webhook:
Examples
Important
Incoming webhooks only return JSON with the created task number (2) from the main action (1):
