Webhook
Last updated
Last updated
Webhooks are user-defined HTTP callbacks. Webhooks allow you to build or set up integrations. They are usually triggered by some event, when that event occurs, the source app makes an HTTP request to the URI configured for the webhook.
A detailed description of the webhook setting can be seen in the table below :
Field
Description
Name
The node id of workflow component.
Webhook Path
Path of the webhook
White List
IP or hostname can access to the webhook (e.g 10.1***domain.com).
URL
This field will be filled automatically.
Response Expression
To simulate the results of the body.
Add
Button to add node id in workflow process.
The URL on this webhook is the default and will be filled automatically when you create a workflow process and add webhook components.
Description of URLs :
{URL} : Used to pass information to the destination.
{Path} : Location of data on the server
{workflow_id} : ID that are automatically created when creating a workflow process.
WF : Code from workflow process (default)
{node_id} : ID obtained from the field name.
{webhook_path} : The keywords entered in the webhook path field (e.g whAddGitlabIssue).
{node_id} and {webhook_path} will automatically be created when adding a node in the workflow process. When a node has not been added, {node_id} and {webhook_path} are {empty}.
In the Add Gitlab Issue Workflow, we take the example of the ‘whAddGitlabIssue’ process. This process is to provide a feedback response to requests sent, this response is in the form of an ‘issue_no’ object whose value is ${addGitlabIssue.response.id}. This ${addGitlabIssue.response.id} variable is to contain the response id of the ‘addGitlabIssue’ process.
To display the response of dialog, you can use the value of success using ${wf.success} variable. ${wf.success} variable serve to define workflow process is true or false. For example, if we set the value of success using $ {wf.success}, when the workflow process starts and in the middle of the process an error occurs, the value success will automatically define that the process is false.
A detailed description of the response expression can be seen in the table below :
Field Name
Description
Value
The value of output
Output
Response output from MVEL function
Success
To display the response of dialog.
If success : true, will display a success response.
If success : false, will display a fail response.
If success : ${wf.success}, to define workflow process is true or false.
Agent
If Agent : True. A dialog will direct to agent,
if Agent : False. A dialog will direct to Bot.
Next
If Next : True. will direct to next entity.
If Next : false. will not direct to next entity.
Repeat
To repeat of dialog.
