The Webhook developer metrics module provides a dashboard to view and analyze an organization’s usage of webhooks. This feature provides data visualization of integration insights.
The Datahub subscriptions module uses webhooks as a push mechanism for data transmission.
The dashboard provides valuable insights into the performance, reliability, usage, and impact of webhooks within a system or application. These metrics enable developers and stakeholders to monitor, troubleshoot, and optimize the webhook integration experience.
The dashboard provides details in the following tabs:
- Overview: Displays legends and graphs based on various metrics, such as Webhook request, Webhook response time, and Top 3 event groups
- Webhook calls: Lists all the webhook transactions
- Events: Lists the event details or payloads for webhook calls
Overview #
The Overview tab includes the following sections:
- Legends that contain data aggregation and summarization based on webhook metrics, such as total webhook request, webhook response time, and number of subscriptions.
- Graphical representation of various metrics, such as webhook request, webhook response time, and message size.
In the Datahub Portal module > click Webhook
. The Webhook developer metrics page is displayed.
Duration
You can view the webhook details for the selected period. The following options are available: day, week, month, quarter, and year.
- By default, webhook details are displayed for the current week.
- When you select the duration, the date range is displayed on the left.
Legends #
The webhook metrics are displayed as legends.
Available legends
Values for each metric are displayed for the selected duration.
|
Legend name |
Description |
|
Total webhook request |
The total number of webhook requests sent for data transmission |
|
Webhook success |
The total number of webhook requests successfully executed while transmitting data The percentage of successfully delivered webhook requests is displayed. Webhook success percentage = (Total number of successfully delivered webhook requests / Total number of webhook requests sent) * 100 |
|
Webhook failed |
The total number of undelivered webhook requests while transmitting data The percentage is displayed of the webhook requests that were not delivered. Webhook failure percentage = (Total number of unsuccessful webhook requests / Total number of sent webhook requests) * 100 This metric visualizes how many webhooks have failed, so that appropriate action can be initiated if too many webhooks are failing. |
|
Webhook response time |
Average response time a receiver |
|
Message sent |
Total number of sent webhook messages while transmitting data |
|
Message size |
Total size of all sent webhook messages while transmitting data |
|
Number of subscriptions |
Total number of subscriptions in the Datahub subscription module |
|
Active subscriptions |
Total number of subscriptions that are actively storing and transmitting the data to subscriber organizations |
|
Inactive subscriptions |
Total number of subscriptions that are inactive (not storing and transmitting data to subscriber organizations) |
This section describes the various graphical representations based on certain webhook metrics for the selected duration.
Hover over each graph to view the data points and other details for that particular duration.
Webhook request #
The Webhook request graph charts the number of webhook requests that were successful versus those that failed. 
Webhook response time #
The Webhook response time graph provides data on the average webhook response time. 
- The blue line represents the average webhook response time in milliseconds.
Message sent #
The Message sent graph provides data on the number of messages sent.
Message size #
The Message size column chart provides data on the cumulative size of the messages sent.
- The blue bar represents the size of the messages sent in millions.
Top 3 event groups #
The Top 3 event groups clustered column chart provides data on the three most used event groups.
- The bars represent different event groups used in thousands. The top 3 events may vary for different durations, hence, the colors representing these events may change.
- If webhook data is unavailable, the following message is displayed on the Webhook developer metrics page: “No records to show”.
- If webhook data cannot be retrieved due to background processes, the following message is displayed on the Webhook developer metrics page: click Reload to refresh the page.
Webhook calls #
The administrator can view webhook call details, such as webhook endpoint (URL), subscription name, batch ID, and elapsed time.
In the Datahub Portal module > click Webhook > click the Webhook calls tab. The webhook call details are displayed.
Available columns
|
Column |
Description |
|
Date and time |
Date and time when the webhook endpoint (URL) was created |
|
Subscription name |
Subscription name to which the webhook endpoint (URL) belongs |
|
Batch ID |
Batch ID associated with the webhook endpoint (URL) |
|
Webhook endpoint (URL) |
The URL or the endpoint to which the data will be transmitted |
|
Elapsed time |
The total time required for a request to be sent and a response to be received from the destination server |
|
Request size |
Webhook request size |
|
Integrator |
Integrator name through which the data is transmitted |
|
Organization |
Subscriber organization name |
|
Status code |
Code that indicates whether the request was successfully processed by the receiving server |
|
Retry count |
Number of times a webhook provider has attempted to resend an event notification after the initial attempt failed |
Click sort 
in the column headers to sort records in ascending or descending order.
View webhook endpoint URL details #
The administrator can view webhook endpoint (URL) call details, such as event name, event count, subscription name, batch ID, and elapsed time.
- In the Datahub Portal module > click Webhook
> click Webhook calls tab. The webhook call details are displayed. - Click the Webhook endpoint (URL) row to view its details. The View webhook call page is displayed.
Available rows
Filter webhook calls #
You can filter webhook call details based on the duration.
- In the Datahub Portal module > click Webhook > click Webhook calls tab. The webhook call details are displayed.
- Click Filters and then select the required option. The records are filtered.
- To clear the applied filter criteria, click Reset all.
- To close the filter pane, click Close
.
.Search webhook calls #
You can search webhook call details by using the Search feature.
- In the Datahub Portal module > click Webhook > click the Webhook calls tab. The webhook call details are displayed.
- In the Search box, enter the search criteria. The records matching the search criteria are displayed.
Enter a character to initiate a search operation.
Events #
Webhook calls are associated with events. An administrator can view event details, such as event name, total number of messages, total size of data transferred, and percentage.
In the Datahub Portal module > click Webhook > click the Events tab. The event details are displayed.
Available columns
|
Column |
Description |
|
Event name |
Name of the event |
|
Total number of messages |
Total count of the messages that were transmitted |
|
Total size of data transferred |
Total size of the messages that were transferred |
|
Percentage (%) |
Indicates which event was most used.
Percentage (%) = Number of messages / Total number of events |
Click sort in the Event name column header to sort records in ascending or descending order.
View event details #
The administrator can view event details, such as event name, total number of messages, and total size of data transferred.
- In the Datahub Portal module > click Webhook > click the Events tab. The event details are displayed.
- Click the event row to view its details. The View events details page is displayed.
Available rows
Filter events #
You can filter for event details based on the duration selected.
- In the Datahub Portal module > click Webhook > click the Events tab. The event details are displayed.
- Click Filters and then select the required option. The records are filtered.
- To clear the applied filter criteria, click Reset all.
- To close the filter pane, click Close .
Search events #
You can search event details by using the Search feature.
- In the Datahub Portal module > click Webhook > click the Events tab. The event details are displayed.
- In the Search box, enter the search criteria. The records matching the search criteria are displayed.
Enter a character to initiate a search operation.
