> ## Documentation Index
> Fetch the complete documentation index at: https://cashfreepayments-d00050e9-theme-update.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

> Webhooks are server callbacks to your server from Cashfree payments.

Webhooks are event-based notifications that are received when a specific event related to the account aggregator occurs.

## Add webhooks

Add your webhook URL in our system for us to deliver webhook events.

Follow the instructions below to configure the webhook URL. Ensure to provide the publicly accessible HTTPS URL to your webhook endpoint.

1. Log in to the **[Merchant Dashboard](https://merchant.cashfree.com/merchants/)** and click **Developers**.
2. Click **Webhooks** listed under the **Secure ID** card.
3. Click **Add Webhook URL** in the **Webhook** screen.
4. In the **Add Webhook** popup, fill in the following information:

* **Webhook URL** - Enter the URL in this field.

5. Click **Test & Add Webhook**.

<Frame caption="Add Webhook">
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/cashfreepayments-d00050e9-theme-update/static/secure-id/webhook.png" />
</Frame>

## Consent webhook event

| Event                               | Description          |
| :---------------------------------- | :------------------- |
| AA\_CONSENT\_VERIFICATION\_SUCCESS  | Consent is approved. |
| AA\_CONSENT\_VERIFICATION\_PAUSED   | Consent is paused.   |
| AA\_CONSENT\_VERIFICATION\_REVOKED  | Consent is revoked.  |
| AA\_CONSENT\_VERIFICATION\_REJECTED | Consent is rejected. |
| AA\_CONSENT\_VERIFICATION\_EXPIRED  | Consent has expired. |

<CodeGroup>
  ```Text AA_CONSENT_VERIFICATION_SUCCESS
  {
      "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
      "event_type": "AA_CONSENT_VERIFICATION_SUCCESS",
      "event_time": "2024-02-15 16:53:15",
      "version": "v1",
      "data": {
      "status": "SUCCESS",
      "consent_verification_id": "a12bc34def56789"
      }
  }
  ```

  ```Text AA_CONSENT_VERIFICATION_PAUSED
  {
      "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
      "event_type": "AA_CONSENT_VERIFICATION_PAUSED",
      "event_time": "2024-02-15 16:53:15",
      "version": "v1",
      "data": {
      "status": "PAUSED",
      "consent_verification_id": "a12bc34def56789"
      }
  }
  ```

  ```Text AA_CONSENT_VERIFICATION_REVOKED
  {
      "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
      "event_type": "AA_CONSENT_VERIFICATION_REVOKED",
      "event_time": "2024-02-15 16:53:15",
      "version": "v1",
      "data": {
      "status": "REVOKED",
      "consent_verification_id": "a12bc34def56789"
     }
  }
  ```

  ```Text AA_CONSENT_VERIFICATION_REJECTED
  {
      "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
      "event_type": "AA_CONSENT_VERIFICATION_REJECTED",
      "event_time": "2024-02-15 16:53:15",
      "version": "v1",
      "data": {
      "status": "REJECTED",
      "consent_verification_id": "a12bc34def56789"
      }
  }
  ```

  ```Text AA_CONSENT_VERIFICATION_EXPIRED
  {
      "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
      "event_type": "AA_CONSENT_VERIFICATION_EXPIRED",
      "event_time": "2024-02-15 16:53:15",
      "version": "v1",
      "data": {
      "status": "EXPIRED",
      "consent_verification_id": "a12bc34def56789"
      }
  }
  ```
</CodeGroup>

## FI webhook event

| Event                         | Description                                       |
| :---------------------------- | :------------------------------------------------ |
| AA\_FI\_VERIFICATION\_SUCCESS | Financial information verification is successful. |
| AA\_FI\_VERIFICATION\_ACTIVE  | Financial information consent is active.          |
| AA\_FI\_VERIFICATION\_FAILED  | Financial information verification has failed.    |
| AA\_FI\_VERIFICATION\_EXPIRED | Financial information verification has expired.   |

<CodeGroup>
  ```Text AA_FI_VERIFICATION_ACTIVE
  {
      "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
      "event_type": "AA_FI_VERIFICATION_ACTIVE",
      "event_time": "2024-02-15 16:53:15",
      "version": "v1",
      "data": {
      "status": "ACTIVE",
      "fi_verification_id": "v1234567890abcdef",
      "fi_status_response": [
              {
                  "fip_id": "FIP_1",
                  "accounts": [
                      {
                          "link_ref_number": "b2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b",
                          "fi_status": "READY"
                      },
                      {
                          "link_ref_number": "a2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b",
                          "fi_status": "TIMEOUT"
                      }
                  ]
              },
              {
                  "fip_id": "FIP_2",
                  "accounts": [
                      {
                          "link_ref_number": "c2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b",
                          "fi_status": "READY"
                      }
                  ]
              }
          ]
      }
  }
  ```

  ```Text AA_FI_VERIFICATION_SUCCESS
  {
      "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
      "event_type": "AA_FI_VERIFICATION_SUCCESS",
      "event_time": "2024-02-15 16:53:15",
      "version": "v1",
      "data": {
      "status": "SUCCESS",
      "fi_verification_id": "v1234567890abcdef",

      }
  }
  ```

  ```Text AA_FI_VERIFICATION_FAILED
  {
      "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
      "event_type": "AA_FI_VERIFICATION_FAILED",
      "event_time": "2024-02-15 16:53:15",
      "version": "v1",
      "data": {
      "status": "FAILED",
      "fi_verification_id": "v1234567890abcdef",

      }
  }
  ```

  ```Text AA_FI_VERIFICATION_EXPIRED
  {
      "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
      "event_type": "AA_FI_VERIFICATION_EXPIRED",
      "event_time": "2024-02-15 16:53:15",
      "version": "v1",
      "data": {
      "status": "EXPIRED",
      "fi_verification_id": "v1234567890abcdef",

      }
  }
  ```
</CodeGroup>

## Webhook payload fields

The webhook payload contains important metadata in its top-level fields.

| Field        | Type     | Description                                                                                    |
| ------------ | -------- | ---------------------------------------------------------------------------------------------- |
| `signature`  | `string` | A Base64-encoded HMAC-SHA256 signature of the payload, generated using a shared client secret. |
| `event_type` | `string` | Indicates the type of event that triggered the webhook.                                        |
| `event_time` | `string` | The UTC timestamp of when the event occurred, formatted in ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`).  |
| `version`    | `string` | Indicates the webhook format being used. Default version is "v1".                              |
| `data`       | `object` | Contains event-specific details related to this feature.                                       |

<Note>
  Verifying the signature is mandatory before processing any response. Refer to [Signature Verification](/api-reference/vrs/webhook-signature-verification#webhook-signature-verification) for more details.
</Note>