Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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 NameDescription
On File ReceivedReceives 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. NoVariable NameDescriptionDefault value
    1responseThe response text to be sent as successful response 
    2faultThe response text to be sent as invalid response 
    3statusCodeThe HTTP status code202 for successful response, 500 for invalid response
    4contentType

    The content type of response

     

    text/plain

    restWebhook.response.fileLocation


    responseContentType

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

 

 

  • No labels