> For the complete documentation index, see [llms.txt](https://docs.delos.financial/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.delos.financial/hooks/get-hook-parameters.md).

# Get Hook Parameters

Retrieves the current webhook configuration settings. Webhooks allow your system to receive real-time notifications about events in the payment system.

**Endpoint**

`GET/v2/hook/get`

**Link**

{% embed url="<https://stagep.tst-apidmndelss.com/openapi/v2.html#/operations/Hook_GetParameters>" %}

### **Request**

#### **Headers**

| Key      | Value              | Required |
| -------- | ------------------ | -------- |
| `Accept` | `application/json` | Yes      |

*Note: No authorization required for this endpoint.*

***

### **Response (200 OK)**

Returns the current webhook configuration settings.

#### **Response Fields**

| Field                    | Type      | Description                                                       | Example                                 |
| ------------------------ | --------- | ----------------------------------------------------------------- | --------------------------------------- |
| **`enabled`**            | `boolean` | **Webhook feature status**. `true` = active, `false` = disabled.  | `true`                                  |
| **`hookUrl`**            | `string`  | **URL where webhook notifications are sent**.                     | `"https://api.yourdomain.com/webhooks"` |
| **`jwtSecret`**          | `string`  | **Secret key for JWT verification** of incoming webhook requests. | `"your-jwt-secret-key-123"`             |
| **`hookCustomer`**       | `boolean` | **Customer events**: Notifications for customer-related changes.  | `true`                                  |
| **`hookOperation`**      | `boolean` | **Operation events**: Notifications for transaction operations.   | `true`                                  |
| **`hookDepositAccount`** | `boolean` | **Deposit account events**: Notifications for account changes.    | `false`                                 |
| **`hookCounterparty`**   | `boolean` | **Counterparty events**: Notifications for counterparty changes.  | `true`                                  |

**Example Response:**

json

```
{
  "enabled": true,
  "hookUrl": "https://api.yourdomain.com/webhooks/payments",
  "jwtSecret": "sec_5f3d8e2a789bcd1234567890",
  "hookCustomer": true,
  "hookOperation": true,
  "hookDepositAccount": false,
  "hookCounterparty": true
}
```

***

### **Examples**

#### **Request**

bash

```
curl -X GET 'https://stagep.tst-apidmndelss.com/v2/hook/get' \
  -H 'Accept: application/json'
```

#### **Response with All Features Disabled**

json

```
{
  "enabled": false,
  "hookUrl": "",
  "jwtSecret": "",
  "hookCustomer": false,
  "hookOperation": false,
  "hookDepositAccount": false,
  "hookCounterparty": false
}
```

***

### **Event Types Explained**

* **`hookCustomer`**: Customer creation, updates, status changes
* **`hookOperation`**: Payment processing, transfers, transactions
* **`hookDepositAccount`**: Account balance changes, account updates
* **`hookCounterparty`**: Counterparty/bank details changes

***

### **Notes**

* **Security**: The `jwtSecret` is used to verify incoming webhook requests. Keep it secure.
* **URL Requirements**: The `hookUrl` must be HTTPS for production environments.
* **Enablement**: All event types require `enabled: true` to function.
* **Retry Mechanism**: Webhooks typically include retry logic for failed deliveries.

**Webhook Payload Example:**

json

```
{
  "event": "customer.updated",
  "data": {
    "cuid": "DqCsgSE-4e95-ViYbNI",
    "status": "ACCEPTED"
  },
  "timestamp": "2024-05-21T10:30:00Z"
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.delos.financial/hooks/get-hook-parameters.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.