Difference between revisions of "Webhooks"
Jump to navigation
Jump to search
| (33 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| + | 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 == | ||
| + | |||
| + | Web Hooks are a great way to integrate Hornbill with other applications that are accessible over the internet. Web Hooks can send information from Hornbill to another application as soon as a record is updated, rather than relying on scheduled imports or the continually polling for data. | ||
| + | |||
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. | ||
| − | === HTTP Protocol Information | + | |style="width:5%"| |
| − | Your web hook should accept a POST verb with either XML or JSON content as the payload (set by webhook properties). For pre-action hooks such as OnCreate, OnUpdate and OnDelete asyncCritical types it is possible to send an error message from your web hook back to the user's screen. To do this simply respond with a 403 response code, set the Content-type: header to text/plain and the actual text message you want to return to the users display in the response body, the response body should be returned | + | | |
| + | |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 == | ||
| + | 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 == | ||
| + | :* '''URL''' | ||
| + | ::The target URL for the Web Hook. This will typically be a php or asp page that you have created | ||
| + | :* '''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 == | ||
| + | Your web hook should accept a POST verb with either XML or JSON content as the payload (set by webhook properties). For pre-action hooks such as OnCreate, OnUpdate and OnDelete asyncCritical types it is possible to send an error message from your web hook back to the user's screen. To do this simply respond with a 403 response code, set the Content-type: header to text/plain and the actual text message you want to return to the users display in the response body, the response body should be returned as UTF-8 encoded bytes if non-ascii content is requited. | ||
| + | |||
| + | |||
| + | == Testing and Examples == | ||
| + | |||
| + | === RequestBin Test === | ||
| + | The [[http://requestb.in RequestBin]] web site is a third party tool that generates a temporary URL that allows you to collect requests made to it and lets you inspect them in a human-friendly way. Use RequestBin to see what your HTTP client is sending from Hornbill. | ||
| + | |||
| + | [[File:Information.png|14px|text-top|Information]] As RequestBin is a third party tool, Hornbill is not responsible for the availability, quality, security, or any other aspect of this tool | ||
| + | |||
| + | |||
| + | After creating your Web Hook in Hornbill test it using the following steps: | ||
| + | |||
| + | '''Create a Request Bin''' | ||
| + | # Go to the web site http://requestb.in | ||
| + | # Click on the ''Create a RequestBin'' button | ||
| + | # Copy the Bin URL and save it under the URL field in the Web Hook target section of your Hornbill Webhook configuration. | ||
| + | # Create a new Request in Hornbill Service Manager | ||
| + | # Refresh the RequestBin page | ||
| + | # The information from your request should be visible in the format you configured. | ||
| + | |||
| + | |||
| + | === Example Integration === | ||
| + | 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: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.
