Creating WebHooks

Overview

WebHooks give developers an option to implement custom logic that can communicate with other web applications in two ways:

• Outbound: An event happens on Facebook Messenger (e.g. message arrived) > WebHook > Run Decisions Flow
• Inbound: An event happens in Decisions (e.g. assignment complete) > WebHook > External HTTP request

WebHooks are unlike API calls in the manner that API calls are request-based output mechanisms while WebHooks are event-based. 

Example

1. Navigate to System > Integrations > WebHooks to create and manage WebHooks.
2. There are a few WebHooks that have been pre-loaded for users and trigger automatically when the proper event happens.
   1. Assignment Created
   2. Assignment Complete
3. Select Create WebHookto begin. 

   

4. Define the following settings; these will be inputs on the WebHook step that will be available in the Flow Designer. 
   1. Name
   2. Enabled
   3. Data Definitions

   

5. After creating a WebHook, open the Action Menu. 
6. Here, there are the options to Create WebHook Action, Edit, and View Request Data.  

   

7. Selecting View Request Data will show the Data Definitions that were created while creating the WebHook and the Event Name and Date.

   

Create WebHook Action

A WebHook Action defines what the WebHook will do. 

1. To create a Webhook Action, in the WebHook action menu select Create WebHook Action and specify the following fields.
   1. Name
   2. URL
   3. Request Type
   4. Headers
   5. Additional Data
2. Content-Type for POST is application/JSON format. 
   The URL for this example was generated using a WebHook test site.

   

3. After creating a WebHook Action, it becomes available in the WebHook Folder. 
4. The Action Menu allows designers to Delete, Edit, Test, and View Requested Data. 

   

5. When the WebHook Test is run, the WebHook test site immediately updates showing the request details. 

   

Run WebHook by Flow Step 

1. WebHooks are registered as Flow steps under Integration > WebHooks to allow them to be triggered in a Flow.

   

2. See that the Data Definitions defined earlier are available on this step. 

   

Integration Activity

Outbound WebHook activity can be seen on the Integration Activities report found under System > Administration > System Tools > Flow Management.

Expose Flow as a WebHook

Flows can be exposed as WebHooks. 

1. Select View Integration Details in the Flow Designer to see the information on how a Flow can be triggered. 

   

2. For this example, Postman was used to trigger the WebHook.