Difference between revisions of "Webhooks"
Jump to navigation
Jump to search
| (17 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | __NOTOC__[[Main Page|Home]] > [[Administration]] > [[System Administration | System]] > [[System Settings| Settings]] > Webhooks | + | This document can now be found at its new location in the [https://docs.hornbill.com/esp-config/integration/webhooks/ Hornbill Document Library]. |
| + | |||
| + | [[file:hornbill-document-library.png|Hornbill Cloud|link=https://docs.hornbill.com/esp-config/integration/webhooks/]] | ||
| + | <!-- | ||
| + | |||
| + | <div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;"> | ||
| + | __NOTOC__ | ||
| + | {| style="width:100%" | ||
| + | |[[Main Page|Home]] > [[Administration]] > [[System Administration | System]] > [[System Settings| Settings]] > Webhooks | ||
| + | |style="text-align:right;"|[[:Category:Administration|Index]] | ||
| + | |} | ||
| + | </div> | ||
| + | {|style="width: 100%" | ||
| + | |- valign="top" | ||
| + | |style="width:73%"| | ||
== Introduction == | == Introduction == | ||
| Line 5: | Line 19: | ||
A web hook is the opposite to an API call, a web hook is a call over HTTP from your Hornbill instance to a web endpoint of your choosing. Most application actions on a Hornbill instance can trigger an action-specific event when an action is performed. Hornbill can be configured to call to a web end point passing the action-specific data to the web service being invoked. This is a very powerful mechanism that enables true, near real-time integration with other business systems. | A web hook is the opposite to an API call, a web hook is a call over HTTP from your Hornbill instance to a web endpoint of your choosing. Most application actions on a Hornbill instance can trigger an action-specific event when an action is performed. Hornbill can be configured to call to a web end point passing the action-specific data to the web service being invoked. This is a very powerful mechanism that enables true, near real-time integration with other business systems. | ||
| + | |||
| + | |style="width:5%"| | ||
| + | | | ||
| + | |style="width:22%; border-style: solid; border-width: 1px; border-color:#e6e6e6; background-color:#f2f2f2;"| | ||
| + | |||
| + | == Related Articles == | ||
| + | :* [[Hornbill iBridge]] | ||
| + | :* [[Hornbill Open Integration Tools]] | ||
| + | :* [[Hornbill KeySafe]] | ||
| + | |} | ||
| + | {{#ev:youtube|4qPFahQgATE|320|right}} | ||
== Basic Information == | == Basic Information == | ||
| − | + | Webhooks are configured via Hornbill Administration in '''Home > System > Settings > Webhooks''' | |
| − | |||
| − | |||
| − | |||
| − | |||
| + | :* '''Name''' | ||
| + | :: Unique name used to identify the Web Hook in the list. This is a mandatory field. No spaces allowed. | ||
| + | :* '''Description''' | ||
| + | :: Enter a description to allow others to understand the use of this particular Web Hook | ||
| + | :* '''Application''' | ||
| + | ::Select the Hornbill application where the event is coming from | ||
| + | :* '''Event Source''' | ||
| + | :: Select the event | ||
| + | :* '''Enabled''' | ||
| + | :: Enable or disable this Web Hook. This can also be done from the main list of Web Hooks | ||
| + | :* '''Authentication''' | ||
| + | :: Create and safely store authentication credentials to access the End Point using [[Hornbill KeySafe|'''Hornbill KeySafe''']] | ||
| + | <BR> | ||
== Web Hook Target == | == Web Hook Target == | ||
| − | * URL | + | :* '''URL''' |
| − | * Payload Format | + | ::The target URL for the Web Hook. This will typically be a php or asp page that you have created |
| − | * Post Mode | + | :* '''Payload Format''' |
| − | + | ::This defines the format of how you would like the data to be received. Choose from XML or JSON | |
| − | + | :* '''Post Mode''' | |
| − | + | :: ''Asynchronous'' - Fire and forget. Don't worry about the response | |
| + | :: ''Synchronous'' - If a response code other than ''200'' is returned from the webhook URL then the API call will fail. The response body will be returned as the error message if the content type is text/plain. | ||
| + | :: ''Synchronous Critical'' - If there is no response a ''200'' error is returned from the webhook URL and the API call will fail | ||
| + | <BR> | ||
== HTTP Protocol Information == | == HTTP Protocol Information == | ||
| Line 48: | Line 85: | ||
An example to reading the JSON payload from a webhook can be found on [https://github.com/hornbill/goWebhookListener GitHub] - The code is avialable for use under the [https://wiki.hornbill.com/index.php/The_Hornbill_Community_License_(HCL) Hornbill Community Licence]. | An example to reading the JSON payload from a webhook can be found on [https://github.com/hornbill/goWebhookListener GitHub] - The code is avialable for use under the [https://wiki.hornbill.com/index.php/The_Hornbill_Community_License_(HCL) Hornbill Community Licence]. | ||
| − | [[Category:Administration]][[Category:Integration]] | + | [[Category:Administration]][[Category:Integration]][[Category:Videos]][[Category:HDOC]] |
| + | --> | ||
| + | <!-- esp-config/integration/webhooks --> | ||
| + | [[Category:HDOC]] | ||
Latest revision as of 18:12, 10 April 2024
This document can now be found at its new location in the Hornbill Document Library.
