In Alloy, a Webhook is a tool that allows the Alloy platform to create an outgoing request when something happens.
There are multiple scenarios where webhooks can be used in Alloy. All scenarios relate to different events which take place in the Alloy platform, which external systems may need to be notified of programmatically (for example, if a note is added to a particular evaluation or a manual review is finalized, this information can be synchronized back to a central CRM such as Salesforce).
There are several events for which webhooks can be created:
- An Entity is manually reviewed
- A Note is created for an entity/evaluation/review/document
- A Batch evaluation run is completed
- A Group is manually reviewed
- An Asynchronously Updated Evaluation is updated
- This refers to flows using data vendors such as Middesk. Sometimes Middesk requires a human to do research on an entity before returning a result. Clearly, this process takes longer than a typical evaluation which is returned in a matter of seconds. In this case, the workflow will wait for Middesk to return its result, and when it does, this webhook will be fired.
- An Evaluation is created by a Data Vendor Webhook
- This refers to evaluations created for “Recurring” workflow scenarios, for example when a ComplyAdvantage watchlist updates and finds a hit against a previously-run applicant
- An Evaluation is manually rerun
How are webhooks created?
It’s easy to set up new webhooks in Alloy! Follow these steps:
- In order to actually set up a webhook, you will need to supply an endpoint, also known as a listener, to enter into the webhook setup.
- Once you have your endpoint, go to Settings > Webhooks and click on the + WEBHOOK BUTTON
- Enter details of the webhook as follows
- Name - give your webhook an accurate and descriptive name
- Action - select the action you want to use to trigger the webhook
- URL - enter the URL endpoint
- Advanced Settings
- Method - Select the method - we suggest POST by default
- Headers - Use this section to pass any headers in the webhook, for example identifiers flagging that the call comes from Alloy
- Extra JSON data - Where to specify if you need any additional JSON data to be added to the call
- Hit Create and your webhook will be saved
- Go to the workflow you want to associate the webhook with
- Click + ADD WEBHOOK and select the webhook you just created
And you’re done!