Create a Webhook Action
Use the webhook action to call a third-party web service. You can create these actions for user initiated, scheduled, or application workflows.
To create a webhook action:
- In the Navigation pane, select Settings > Workflow > User Initiated Workflows, Settings > Workflow > Scheduled Workflows, or Settings > Workflow > Application Workflows
- On the Workflows form, use the drop-down list in the header field to select the hub or other area, such as employees or transaction posting.
- In the Workflows grid, select the workflow row (event) to which you want to add the action.
- In the Actions grid, click Add Action > Webhook.
-
In the
Webhook URL field on the Webhook dialog box, enter the location of the webhook.
After you enter the URL, you can specify the Username and Password, or Secret and Public Key, or both sets of credentials, or no credentials for the webhook.
-
Use the
Authorization fields to specify the username and password for the webhook action.
Note that if you specify a Username or Password, both values must be completed. The Password field is encrypted for added security.
-
Use the
Security fields to record the secret or public key information that is required for the webhook connection.
Note that if you specify a Secret or a Public Key, both values must be completed. The Secret field is encrypted for added security.
-
In the
Configuration fields, set limits on the number of retries allowed and specify how many seconds will elapse before the process times out.
Option Description Retries Set the number of retries allowed. The default value is 0 and the minimum value allowed should be 0. The maximum value allowed is 10. Timeout Set the number of seconds that will elapse before the process times out. The default value is 5 seconds and the minimum value allowed is 1 second. The maximum value allowed is 60 seconds. -
In the Arguments grid, specify name-value pairs for each argument:
- In Name, enter a descriptive name for the argument.
- In Expression, click to display the Expression Builder Dialog Box and then specify the SQL expression that will be used to determine the value of the argument at run time.
- Click +Add Argument to add the argument to the Arguments grid.
- To have the action run after you save the entire record, including all grid data, select the Invoke after changes are saved option.
-
Click
Save.
The action that you created is now listed in the Actions grid of the User Initiated Workflows, Scheduled Workflows, or Application Workflows form.
Parent Topic: How to...