Webhooks Reporting

Updated 

You can create a Webhook Report in Sprinklr to monitor webhook dispatch activity and analyze webhook delivery outcomes. Using the Unified Log Reporting data source, the report provides visibility into webhook dispatch successes and failures, response status codes, subscription activity, retry attempts, and delivery trends.

Webhook Reporting helps you troubleshoot integration issues, identify failed deliveries, monitor webhook traffic, and investigate dispatch behavior across webhook subscriptions.

Key Features

  • Captures webhook dispatch success and failure events.

  • Tracks webhook dispatch volume over time using date or interval-based reporting.

  • Reports HTTP response status codes returned during webhook delivery.

  • Provides visibility into subscription-level webhook activity.

  • Supports analysis of retry attempts for webhook deliveries.

  • Enables filtering and reporting using webhook-specific dimensions and fields.

Key Benefits

  • Comprehensive Visibility: Gain visibility into webhook activity through dimensions such as Subscription Name, Subscription ID, Source, and Status Code, alongside dispatch volume metrics.

  • Faster Troubleshooting: Investigate webhook failures using error messages, status codes, dispatch identifiers, and related entity information.

  • Improved Monitoring: Monitor webhook dispatch trends and identify spikes in failures or retries before they impact downstream systems.

  • Operational Insights: Track delivery performance across webhook subscriptions and understand overall webhook activity patterns.

Prerequisites

Before you begin, ensure the following prerequisites are met:

​

Note: Access to this feature is controlled by the UNIFIED_LOG_REPORTING_ENABLED dynamic property (DP). To enable the Unified Log Reporting data source in your environment, reach out to your Success Manager. Alternatively, you can submit a request at tickets@sprinklr.com.

​

Permissions

You must have the Create permission under Reporting > Dashboards.

Note: If you do not have this permission, reach out to your Sprinklr Administrator to request access.

To check your permissions:

1. Click your user profile in the top-right corner of the Sprinklr platform.

2. Go to the Permissions tab and search for Reporting.

Create a Webhook Report

To create a webhook report, follow these steps:

1. Click the New Page (+) icon to open the Launchpad.

2. On the Launchpad, under Analyze > Reporting, click Care Reporting.

3. On the Reporting Dashboards screen, click Create Dashboard.

4. On the Create Dashboard window, enter the required details and click Create.

5. Next, add and configure a widget to monitor webhook activities. For detailed steps, see the Widget Configuration in Reporting article.

While configuring the widget, complete the following steps:

  • In the Data Source drop-down, select Unified Log Reporting.

​

  • In Define Advanced Options, set Flavour to Webhook.

    ​

    ​

  • In the What would you like to plot on your widget section, select from the supported metrics and dimensions. For the complete list, see the Supported Dimensions and Metrics section.

    ​

Once configured, your widget will appear on the dashboard as shown below:

Supported Dimensions and Metrics

The following dimensions and metrics are supported for Webhook Reporting.

Dimension 

Description 

Source 

The webhook type associated with the event, such as MESSAGE_CREATED or CASE_CREATED. 

Status Code (Filter) 

The HTTP response status code returned for the webhook dispatch. This dimension can be used to filter webhook events by response code. 

Request Timestamp 

The date and time when the webhook log record was created. 

Interval 

A time-based grouping used to analyze webhook activity trends and dispatch volumes over a selected period. 

HostNameIp 

The hostname or IP address of the node that processed the webhook event. 

SubscriptionId 

The unique identifier of the webhook subscription configuration. Available for dispatch-stage webhook events. 

SubscriptionName 

The name configured for the webhook subscription. 

ErrorMessage 

The reason for a failed webhook dispatch. This field is blank for successful webhook events. 

Entity Id 

The identifier associated with the webhook event, such as a Case ID or Message ID. 

Dispatch Id 

A unique identifier for a webhook dispatch attempt. This value can be used to correlate and troubleshoot individual dispatches. 

Webhook Event Id 

The internal identifier associated with the webhook event. 

Retry Count 

The retry attempt number for failed or replayed webhook dispatches. 

Request Payload 

The JSON payload associated with the webhook event. For failure events, this contains the payload sent during dispatch. For successful dispatches, payload data is not stored. 

Measurement 

Description 

Count 

Number of webhook log documents. Primary metric for dispatch volume.

​