Webhooks Report

Introduction

Similar to other Transaction History Reports, the Webhooks Report displays information for webhooks sent by your account across all loans. In this article, we explain how to use the Webhooks Report to its full potential.

If you'd like a refresher on the topic of webhooks, take a look at our Webhooks 101 article.

Webhooks Report

The Webhooks Report is located in the reports section in LMS. To view your account's webhook history, begin by navigating to Reports > Transactions History. This is the dedicated hub for all Reports.

Next, click the 'Web Hook' tab located at the top of the page as shown in the screenshot below.

This page displays all of the webhook activity within your account at a tenant level, and each line is an individual webhook sent by the system. If you click on these lines, you will be sent to the loan account that prompted the webhook. On this page, you can also view and filter the webhooks that have been sent. Let's break down what each column in this report means.

Column Name

Description

Account

This is the display ID that the loan account that prompted the webhook.

Primary Customer

This is the primary customer associated with the loan account.

Collateral

This is the collateral associated with the loan account.

Trace ID

This is a unique identifier that is simply used by the system to track a webhook. LoanPro creates this automatically, and it has no effect on the webhooks themselves. This ID remains the same even if the webhook is retried multiple times.

Event Title

This is the name of webhook that was sent by the system.

Method

This determines what the system does with the information in the webhook. Different methods do different things:

  • GETs pull information
  • POSTs create new information
  • PUTs update existing information
  • DELETEs remove information

Response Code

This is the response code that was received by the system. Like response codes provided by the LoanPro API, successful responses are typically a 200, and unsuccessful responses fall in the 400s and 500s.

Time Stamp

This is the time that the webhook was sent out by the system.

# Attempt Number

This is the attempt number of the webhook that was sent by the system. Unsuccessful webhooks can be configured to be retried, resulting in multiple attempts.

You'll notice that the number of attempts for a webhook starts at "1", and once a webhook is retried for the first time, the number of attempts will show "2". The system counts the initial webhook as the first attempt. So, for example, if your webhook is successful on the third retry, this report will show the # of attempts as "4".

If you would prefer to see some other columns, simply click the "Show/hide columns" icon symbolized by three vertical black bars.

Filtering

To filter your webhook activity, use the Search Options on the left of the page. Webhooks can be filtered like other entities using keywords, statuses, grouping, and more; but webhooks also have a special set of filtering options. Here is a breakdown of each filter:

  • Event Title - This is the name of webhook saved within your account. You can view your webhooks and their names by navigating to Settings > Company > Notifications. Use the drop-down menu to filter webhooks by a specific name.
  • Trace ID - This is a unique identifier that is simply used by the system to track a webhook. LoanPro creates this automatically, and it has no effect on the webhooks themselves. If you need to find a webhook by its Trace ID, you can type the ID into this field.
  • Response Code - This is the response that your webhook received. Like response codes provided by the LoanPro API, successful responses are typically a 200, and unsuccessful responses fall in the 400s and 500s. Use this to filter your webhooks by whether they were successful or not.
  • Method - This is the method that was used by the webhook. The method will either be a GET, PUT, POST, or DELETE.

Expanding Webhook Information

Within the report, you can also expand a webhook's information to view greater detail. To expand a webhook, click the blue arrow icon located on the right.

Expanding a webhook will display a few additional details. Here, you can view the IP address it was sent from, its destination, the response time, and whether the webhook was manually retried. In addition to this information, you can also download the source and response payloads.


How did we do?


Powered by HelpDocs (opens in a new tab)