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).
Supported Webhook Events
There are several events for which webhooks can be created:
Manually Review an Entity
Create new Notes for Entities, Evaluations, Reviews, and Documents
A batch evaluation is completed
Manually Review a Group
Notify on Asynchronously Updated Evaluation
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.
Notify on Evaluation Created by 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
Notify on Rerunning an Evaluations Manually
Notify on Creating an Evaluation Manually
Notify on attempted transaction status update
Notify on attempted bank account status update
Notify on live journey application status change
Notify on sandbox journey application status change
Setting up a Webhook
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: Enter a name for the webhook.
Webhook URL: Enter the endpoint where Alloy should send the webhook.
Select a trigger action: Select the event that should trigger the webhook.
Authentication type: Select an authentication type and complete the fields that appear. If applicable, configure the mTLS Option.
Headers: Add any optional headers.
Extra JSON data: Add any optional JSON data.
Click Test Webhook to confirm the configuration.
Click Create.
And you’re done! The webhook is now configured for the selected trigger action.