The REST WebHook is supported in a Custom Template with the POST method. It also allows users to choose the security policy on the WebHook.
Triggers
A Trigger specifies when a particular Transaction will start executing. While configuring the Source of a Template, you need to choose an event.
Following trigger is available for REST at Source.
| Trigger Name | Description |
|---|---|
| On File Received | Receives data from the specified source. |
Guidelines for Using REST WebHook
Context Variable Handling
User can set context variables of the process flow defined for the custom template in use. Process Flow generate an error code if context variable are not defined. The details of these parameters are given below.
S. No Variable Name Description Default value 1 response The response text to be sent as successful response 2 fault The response text to be sent as invalid response 3 statusCode The HTTP status code 202 for successful response, 500 for invalid response 4 contentType The content type of response
text/plain 5 restWebhook.response.fileLocation Location of the files sent with the response
Sync/Async Mode Handling
- By default, REST WebHook is supported in asynchronous mode. However, to use this in synchronous mode user should send the async parameter with value as false.
Security Policy
While using a REST WebHook, a user can choose to apply the security policy on this WebHook. To apply the security policy, the user should either select the policy from dropdown (already created security policies) or create a new policy by clicking 
.
For creating a new security policy, provide following information:
- Policy Name
- Authentication Type: for now, only Basic authentication type is supported
- User Id
- Password
Click Save.
