> ## Documentation Index
> Fetch the complete documentation index at: https://telr-docs.cashfree.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

> Learn how to configure webhook, logs, analytics, and service alerts.

Add and define webhooks for Payment Gateway, Payment Links, Payment Forms and Subscriptions. Get notified for each action on the URLs configured.

<Frame caption="">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-1.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=5bead6d000a033bb4ae3473a41edd6af" width="2846" height="1608" data-path="static/images/pg/pgwebhook-1.png" />
</Frame>

***

### Add webhook endpoint

To add a new webhook,

1. Go to **Payment Gateway Dashboard** > **Developers** or click the **Developers** option from the homepage.
2. Click **Add Webhook Endpoint** to create a new webhook.  Enter the endpoint URL and select the webhook version using the drop-down menu. The available webhook versions are: 2022-09-01, 2023-08-01. Click on **Test** to verify if the webhook endpoint returns a response. Once done, click **Next**.

<Frame caption="">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-2.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=60bf60f14dacae6163ebfb3128a97289" width="3456" height="1924" data-path="static/images/pg/pgwebhook-2.png" />
</Frame>

3. Select the events for which you want to configure the webhooks and click **Add Webhook**. The available events are:

* dispute closed
* dispute created
* dispute updated
* failed payment
* incident
* instrument active
* instrument failed
* refund
* settlement failed
* settlement initiated
* settlement reversed
* success payment
* success payment tdr
* user dropped payment
* vendor settlement failed
* vendor settlement initiated
* vendor settlement reversed
* vendor settlement success

<Frame caption="">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-3.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=22edc9b0fa486091ffd0e30127858625" width="3444" height="1988" data-path="static/images/pg/pgwebhook-3.png" />
</Frame>

You have successfully created a webhook for the required event. You can view all your webhooks from the Webhook Enpoints homepage. Details such as URL, webhook version, event, and actions are available.

### Test webhook endpoint

You can test the URL at any time using the **Test** option. Click the Test option in the **Test Webhook Endpoint** pop-up. Click **Done** once you get a success response.

<Frame caption="">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-4.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=dc9b3e8d07ef56c09d84b7dda2b48a57" width="3444" height="1988" data-path="static/images/pg/pgwebhook-4.png" />
</Frame>

### Edit webhook endpoint

You also have the option of editing a webhook. Click the **Edit** option on the webhook that is to be edited and select the events you want to add/remove to the webhook. Once done click **Save**.

<Frame caption="">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-5.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=2e601dda97e42f8a029d376412650860" width="3444" height="1988" data-path="static/images/pg/pgwebhook-5.png" />
</Frame>

## Logs

The **Logs** section allows you to view all webhook logs(successful or failed) on your dashboard. Specify the date range to view logs for a particular period.

<Frame caption="">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-6.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=750c023fde8541ccb674528edb9fd823" width="3456" height="1918" data-path="static/images/pg/pgwebhook-6.png" />
</Frame>

Use the **Search & Filter** option to view specific logs. Enter the URL and select the required webhook type from the drop-down menu.

<Frame caption="">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-7.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=64030a6badfc637fa8d8e5e80e661a8e" width="3456" height="1918" data-path="static/images/pg/pgwebhook-7.png" />
</Frame>

Click on a particular request to view more details such as message, time, version, header details, and the payload. If you want to view success or failed logs, navigate to the respective tabs.

<Frame caption="">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-8.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=17718f4980fb58d82f9986cd423406d2" width="3456" height="1918" data-path="static/images/pg/pgwebhook-8.png" />
</Frame>

Watch the video below to learn how logs work.

<iframe width="600" height="400" src="https://app.supademo.com/embed/9epYKcBiRpBQxFlniI2Yj\" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen />

***

## Analytics

The webhook analytics feature provides you with contextual information on the webhook metrics that allow you to track, monitor, and assess the success or failure of your webhooks. Metrics such as Error Counts and Latency are available.

Specify the date range to view the metrics for a particular period. Use the **Search & Filter** option to view specific logs. Enter the URL and select the required webhook type from the drop-down menu.

<Frame caption="Search and Filter">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-10.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=7a4891a32ad5eca08072bcb92388d22c" width="3456" height="1918" data-path="static/images/pg/pgwebhook-10.png" />
</Frame>

***

### Error count

An error count is the count of the different errors received when sending webhooks. Metrics such as the total success count and total failed count are visible. Hover your mouse over the individual date to view the success or failed count.

<Frame caption="Analytics">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-11.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=063ac9a70d9050bde8c53dd8110993b3" width="3456" height="1918" data-path="static/images/pg/pgwebhook-11.png" />
</Frame>

***

### Latency

Latency is the time taken to respond to webhooks. Hover your mouse over the individual date to view the latency count. The average latency value is also provided.

<Frame caption="Latency">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-12.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=07ccad055a13856e74591cafb5bfea2f" width="3456" height="1918" data-path="static/images/pg/pgwebhook-12.png" />
</Frame>

***

## Service alerts

The **Service Alerts** tab allows you to:

* Add webhook URL
* Activate or deactivate webhooks

To add a new webhook,

1. Go to Payment Gateway Dashboard > **Developers** > **Service Alerts**,
2. Click **Add Webhook URL** and specify a valid webhook URL.

<Frame caption="Add Webhook URL">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-13.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=cc6754631b2d050779fb2795f4087bb8" width="3456" height="1918" data-path="static/images/pg/pgwebhook-13.png" />
</Frame>

3. Click **Test & Add** to save the webhook URL. Review your selections and click **Add**. The webhook is added successfully.

<Frame caption="Review webhook URL">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-14.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=f8c682bc991f1dde5e1f3bc7c0e5d54f" width="3456" height="1918" data-path="static/images/pg/pgwebhook-14.png" />
</Frame>

To activate or de-activate a webhook URL, use the toggle button beside the corresponding webhook.

<Frame caption="Enable or Disable Webhook">
  <img src="https://mintcdn.com/telr/twBoEppUroruK7P_/static/images/pg/pgwebhook-15.png?fit=max&auto=format&n=twBoEppUroruK7P_&q=85&s=cac12841fabe4a8938e8d4f561044335" width="3456" height="1918" data-path="static/images/pg/pgwebhook-15.png" />
</Frame>
