Configuring a Web Hook in Biz Core

To setup a Web Hook in Biz Core, use the sidebar to navigate to Settings → Advanced.

From here, open the Web Hooks tab and click Add New Web Hook on the bottom-right of the page to launch the popup window. Using the popup window, complete the fields to create the Web Hook:

Web Hook Event: Using the dropdown menu, choose which record type’s status change should trigger the delivery of the Response Object, by selecting either Lead Status Changed Url, Loan Status Changed Url or Application Status Changed Url. Each of these will send the Response Object each time a record status is changed within the Leads, Loan or Application workspace, respectively. After selecting a Web Hook Event Biz Core will display an example JSON Response Object in the popup window, these are also explained below in Response Objects.
Web Hook Name: Give the Web Hook an internal name for reference, by entering it into the field.
URL: Supply the custom URL from the third-party platform endpoint this Web Hook will be connected to, and delivering the Response Object. For example, Zapier URLs may be formatted as: https://hooks.zapier.com/hooks/catch/XXXXX/XXXXX

After completing the fields click SUBMIT the Web Hook will be created, displaying the Web Hook Event, Web Hook Name and the End-Point URL:

Execution Logs

After a Web Hook is created, users can click the Show Execution Logs button to view the 20 most recent times the Web Hook was executed, sending Response Objects

After Web Hook(s) Configuration

As an example of what will occur after the a Status Change Web Hook is created in Biz Core, assuming a user has created implemented the Loan Status Changed URL option:

Any time a record within the Loans Workspace has a status change, either manually or through automation (such as the loan falling into arrears), Biz Core will immediately build and send the appropriate Response Object.
Each field in the JSON Response Object, explained further below, will be populated with customer- and subscription-specific information. For example, the phoneNumber field will be appended with the customer’s phone number.
The Response Object will then be delivered to the unique Web Hook URL provided during configuration.

Integration with Third-Party Automation Platforms

The purpose of the Status Change Web Hook feature is to integrate with third-party platforms, such as Zapier. After successfully connecting and configuring the Web Hook, users have the ability to use a wide array of task automation and workflows available through the third-party.

In order to successfully implement their desired workflows with the Web Hook, users may need to consult with a developer to ensure that they can correctly design the actions performed after the Response Object is received.

Response Objects

The JSON Response Object for each of the Status Change Web Hook events is explained below. Each field is populated with general subscription, or record-specific data, if it is available. Should the information not exist within Biz Core, the object will still execute and send, but that specific field will be blank when received by the third-party platform. For example, if a customer address is not stored on their customer record, the Response Object will be received either without the address fields, or the fields will be blank. The fields contained in the Response Object also cannot be filtered from Biz Core, the system will always send all available data in the JSON payload, instead any filtering must be done from the third-party platform that is connected through the Web Hook.

Additionally, a Response Object will also always be sent upon every status change, users cannot select specific status changes for which the update will be provided or not. Instead this filtering must be done within the third-party platform connected to Biz Core through the Web Hook.

Lead Status Changed URL

JSON Response Object

{
  "subscriptionId": "c6e0bdca-2947-4b09-b01f-9b475fee7e19",
  "leadId": "32eea42a-82d2-41f7-bfeb-7ef3bf17ad6a",
  "leadRef": "lead-ref",
  "leadStatus": "Converted",
  "statusDate": "0001-01-01T00:00:00+00:00",
  "loanRef": null,
  "customerRef": "customer-ref",
  "loanApplicationRef": "application-ref",
  "firstName": "Test",
  "lastName": "Customer",
  "dateOfBirth": "0001-01-01T00:00:00",
  "companyName": null,
  "tradingName": null,
  "emailAddress": "[email protected]",
  "phoneNumber": "0400000000",
  "phoneTypeId": 1,
  "phoneType": "Mobile",
  "address": {
    "premise": "1",
    "streetAddress": "Test Street",
    "postalCode": "4000",
    "locality": "Test Suburb",
    "administrativeArea": "Queensland",
    "country": "Australia",
    "contactId": null
  },
  "customerTags": [
    "Tag1",
    "Tag2"
  ],
  "leadSource": "lead-source",
  "leadCampaign": "lead-campaign",
  "leadMedium": "lead-medium",
  "leadIdentifiers": "[]",
  "gaClientID": null
}

JSON Key/Value Pairs Explained

Key	Value
subscriptionId	The unique subscription ID associated with the Biz Core Portal.
leadId	The unique ID associated with the Lead Record.
leadRef	The unique Biz Core reference number for the Lead Record.
leadStatus	The current status of the Lead Record.
statusDate	The date and time the Lead Record entered it’s current status, shown in GMT+00:00 time.
loanRef	The unique reference number for the Loan Record associated with the Lead Record. If the Lead is successfully converted into a Loan it’s reference number will be input here.
customerRef	The unique reference number for the Customer Record associated with the Lead Record.
loanApplicationRef	The unique Biz Core reference number for the Application Record associated with the Lead Record. If a Lead is successfully converted into an Application it’s reference number will be input here.
firstName	The first name of the customer.
lastName	The surname of the customer.
dateOfBirth	The customer’s date of birth.
companyName	If the Lead is for a business loan, this will display the company name.
tradingName	If the Lead is for a business loan, this will display the companies trading name.
emailAddress	The customer’s email address.
phoneNumber	The customer’s phone number.
phoneTypeId	The phone number type ID: 1 for mobile, 2 for residential, 3 for business.
phoneType	The type of phone number, mobile, residential or business.
address	The following fields will contain address details. If the customer has multiple addresses recorded, each one will be listed separately.
premise	The unit/level number of the address, if applicable.
streetAddress	The street address of the address.
postalCode	The post code of the address.
locality	The suburb or equivalent of the address.
administrativeArea	The state, territory or equivalent of the address.
country	The country of the address.
contactId	The unique ID associated with the address.
customerTags	Any tags that have been added to the Customer Record are included here.
leadSource	Any URL identifier information that has been passed through the leadSource= field is included here.
leadCampaign	Any URL identifier information that has been passed through the campaign= field is included here.
leadMedium	Any URL identifier information that has been passed through the leadMedium= field is included here.
leadIdentifiers	Any URL identifier information that has been passed through the customisable identifiers=`{"key1":"val1","key2":"val2"}` field is included here.
gaClientID	If the Google Analytics Client ID is captured this will be included here.

Application Status Changed URL

JSON Response Object

{
  "subscriptionId": "42323032-8057-4108-85af-d8bd5789ecff",
  "loanApplicationId": "a16b106d-9a84-4b50-8a52-f9471ed98022",
  "loanApplicationRef": "application-ref",
  "loanApplicationStatus": "New",
  "declinedWithdrawReason": "Low credit score",
  "statusDate": "2024-01-10T09:49:11.357226+10:00",
  "loanRef": "loan-ref",
  "customerRef": "customer-ref",
  "firstName": "Test",
  "lastName": "Customer",
  "dateOfBirth": "0001-01-01T00:00:00",
  "companyName": null,
  "tradingName": null,
  "emailAddress": "[email protected]",
  "phoneNumber": "0400000000",
  "phoneTypeId": 1,
  "phoneType": "Mobile",
  "address": {
    "premise": "1",
    "streetAddress": "Test Street",
    "postalCode": "4000",
    "locality": "Test Suburb",
    "administrativeArea": "Queensland",
    "country": "Australia",
    "contactId": null
  },
  "customerTags": [
    "Tag1",
    "Tag2"
  ],
  "leadRef": "lead-ref",
  "leadIdentifiers": "[]",
  "gaClientID": null
}

JSON Key/Value Pairs Explained

Key	Value
subscriptionId	The unique subscription ID associated with the Biz Core Portal.
loanApplicationId	The unique ID associated with the Application Record.
loanApplicationRef	The unique Biz Core reference number for the Application Record.
loanApplicationStatus	The current status of the Application Record.
declinedWithdrawnReason	The reason the Application was Declined or Withdrawn.
statusDate	The date and time the Application Record entered it’s current status, shown in GMT+00:00 time.
loanRef	The unique Biz Core reference number for the Loan Record associated with the Application Record. If the Application is successfully converted into a Loan it’s reference number will be input here.
customerRef	The unique reference number for the Customer Record associated with the Application Record.
firstName	The first name of the customer.
lastName	The surname of the customer.
dateOfBirth	The customer’s date of birth.
companyName	If the Application is for a business loan, this will display the company name.
tradingName	If the Application is for a business loan, this will display the companies trading name.
emailAddress	The customer’s email address.
phoneNumber	The customer’s phone number.
phoneTypeId	The phone number type ID: 1 for mobile, 2 for residential, 3 for business.
phoneType	The type of phone number, mobile, residential or business.
address	The following fields will contain address details. If the customer has multiple addresses recorded, each one will be listed separately.
premise	The unit/level number of the address, if applicable.
streetAddress	The street address of the address.
postalCode	The post code of the address.
locality	The suburb or equivalent of the address.
administrativeArea	The state, territory or equivalent of the address.
country	The country of the address.
contactId	The unique ID associated with the address.
customerTags	Any tags that have been added to the Customer Record are included here.
leadRef	The unique Biz Core reference number for the Lead Record associated with the Application Record. If the Application has been successfully converted from a Lead it’s reference number will be input here.
leadIdentifiers	Any URL identifier information that has been passed through the customisable identifiers=`{"key1":"val1","key2":"val2"}` field is included here.
gaClientID	If the Google Analytics Client ID is captured this will be included here.

Loan Status Changed URL

JSON Response Object

{
  "subscriptionId": "fe081786-ac17-4704-8824-e275c070eb8f",
  "loanId": "ead0a78c-8d5d-4ca1-8f31-590addcdd1e5",
  "loanRef": "loan-ref",
  "loanStatus": "Active",
  "statusDate": "2024-01-10T09:49:11.3534466+10:00",
  "loanApplicationRef": "application-ref",
  "customerRef": "customer-ref",
  "leadRef": "lead-ref",
  "firstName": "Test",
  "lastName": "Customer",
  "dateOfBirth": "0001-01-01T00:00:00",
  "companyName": null,
  "tradingName": null,
  "emailAddress": "[email protected]",
  "phoneNumber": "0400000000",
  "phoneTypeId": 1,
  "phoneType": "Mobile",
  "address": {
    "premise": "1",
    "streetAddress": "Test Street",
    "postalCode": "4000",
    "locality": "Test Suburb",
    "administrativeArea": "Queensland",
    "country": "Australia",
    "contactId": null
  },
  "customerTags": [
    "Tag1",
    "Tag2"
  ],
  "leadIdentifiers": "[]",
  "gaClientID": null
}

JSON Key/Value Pairs Explained

Key	Value
subscriptionId	The unique subscription ID associated with the Biz Core Portal.
loanId	The unique ID associated with the Loan Record.
loanRef	The unique Biz Core reference number for the Loan Record.
loanStatus	The current status of the Loan Record.
statusDate	The date and time the Loan Record entered it’s current status, shown in GMT+00:00 time.
loanApplicationRef	The unique Biz Core reference number for the Application Record associated with the Loan Record. If the Loan has been successfully converted from an Application it’s reference number will be input here.
customerRef	The unique reference number for the Customer Record associated with the Loan Record.
leadRef	The unique Biz Core reference number for the Lead Record associated with the Loan Record. If the Loan has been successfully converted from a Lead it’s reference number will be input here.
firstName	The first name of the customer.
lastName	The surname of the customer.
dateOfBirth	The customer’s date of birth.
companyName	If the Loan is for a business loan, this will display the company name.
tradingName	If the Loan is for a business loan, this will display the companies trading name.
emailAddress	The customer’s email address.
phoneNumber	The customer’s phone number.
phoneTypeId	The phone number type ID: 1 for mobile, 2 for residential, 3 for business.
phoneType	The type of phone number, mobile, residential or business.
address	The following fields will contain address details. If the customer has multiple addresses recorded, each one will be listed separately.
premise	The unit/level number of the address, if applicable.
streetAddress	The street address of the address.
postalCode	The post code of the address.
locality	The suburb or equivalent of the address.
administrativeArea	The state, territory or equivalent of the address.
country	The country of the address.
contactId	The unique ID associated with the address.
customerTags	Any tags that have been added to the Customer Record are included here.
leadIdentifiers	Any URL identifier information that has been passed through the customisable identifiers=`{"key1":"val1","key2":"val2"}` field is included here.
gaClientID	If the Google Analytics Client ID is captured this will be included here.