> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.omicx.one/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.omicx.one/_mcp/server.

# Danh sách Webhook

GET https://api.omicx.one/webhooks/

Danh sách có phân trang, kèm trạng thái chặn theo thời gian thực (`blocked`, `blockedUntil`, `errorCount`). **Scope yêu cầu:** `webhook:read`.

Reference: https://developers.omicx.one/integrations/webhooks/list-webhooks

## Request

### Query parameters

- `page` (integer, optional, default: 1)
- `size` (integer, optional, default: 20)

### Headers

- `X-Api-Key` (string, required)

## Response

### 200

Trang danh sách webhook.

- `data` (list of WebhookView, optional)
- `page` (integer, optional)
- `size` (integer, optional)

## Errors

### 401 Unauthorized Error

Thiếu hoặc sai API key.

- `error` (ErrorResponseError, optional)

### 403 Forbidden Error

Thiếu scope `webhook:read`.

- `error` (ErrorResponseError, optional)

### 502 Bad Gateway Error

webhook-service tạm thời không khả dụng.

- `error` (ErrorResponseError, optional)

## Types

### WebhookView

Webhook do webhook-service trả về — không bao giờ chứa giá trị bí mật gốc.

- `id` (string, optional)
- `tenantId` (string, optional)
- `name` (string, optional)
- `events` (list of string, optional)
- `config` (WebhookConfig, optional)
- `status` (enum, optional)
  - Allowed values: `ENABLED`, `DISABLED`, `DELETED`
- `createdAt` (long, optional)
- `updatedAt` (long, optional)
- `lastExecutedAt` (long, optional, nullable)
- `blocked` (boolean, optional) — Lượt gửi tới webhook này có đang bị tạm giữ do chặn lỗi hay không.
- `blockedUntil` (long, optional, nullable) — Epoch millis khi trạng thái chặn hết hạn (chỉ có khi đang bị chặn).
- `errorCount` (long, optional) — Số lần lỗi trong cửa sổ trượt hiện tại.

### ErrorResponseError

- `code` (string, optional) — Nhóm lỗi (dạng máy đọc được), ổn định theo từng HTTP status.
- `subCode` (string, optional) — Mã cụ thể, ổn định — dùng để phân nhánh xử lý / dịch i18n. Hãy xử lý logic dựa trên `subCode`, không dựa vào chuỗi `message`.
- `message` (string, optional) — Mô tả cho con người đọc (dùng để debug), không nên dịch trực tiếp.
- `timestamp` (datetime, optional)
- `path` (string, optional) — Đường dẫn request đầy đủ.
- `details` (list of ErrorResponseErrorDetailsItems, optional) — Chỉ xuất hiện khi `code` là `VALIDATION_ERROR` — danh sách lỗi theo từng trường.

### WebhookConfig

- `url` (string, required) — Endpoint http(s) công khai của bạn (có chống SSRF).
- `method` (enum, optional, default: POST)
  - Allowed values: `POST`, `PUT`
- `authType` (enum, optional, default: NONE) — `NONE` — không kèm xác thực. `API_KEY` — gửi kèm `apiKey` trong header `X-API-KEY` của mỗi lượt gửi. `CUSTOM_HEADER` — gửi kèm một hoặc nhiều header tuỳ chỉnh khai báo trong `headers`.
  - Allowed values: `NONE`, `API_KEY`, `CUSTOM_HEADER`
- `apiKey` (string, optional) — Chỉ ghi (write-only) — dùng khi `authType` là `API_KEY`, được gửi dưới dạng header `X-API-KEY` khi giao payload.
- `hasApiKey` (boolean, optional) — (Chỉ có trong response) Webhook này đã cấu hình `apiKey` hay chưa.
- `headers` (list of WebhookKeyValue, optional) — Dùng khi `authType` là `CUSTOM_HEADER` — giá trị (`value`) chỉ ghi, response chỉ trả về tên header kèm giá trị đã che (`********`).
- `params` (list of WebhookKeyValue, optional) — Query param bổ sung, được gắn thêm vào URL khi giao payload.
- `retryEnabled` (boolean, optional) — Tự động gửi lại khi thất bại (mặc định `true`).
- `blockIfError` (boolean, optional) — Tự động chặn (block) sau nhiều lần thất bại liên tiếp (mặc định `true`).
- `blockAfterTimes` (integer, optional) — Số lần lỗi trong cửa sổ trượt trước khi bị chặn (`0` = dùng mặc định hệ thống).
- `alertOnFailure` (boolean, optional) — Gửi email khi một đợt lỗi (outage) mới bắt đầu (mặc định `true`).
- `alertOnRecovery` (boolean, optional) — Gửi email khi endpoint hồi phục (mặc định `true`).

### ErrorResponseErrorDetailsItems

### WebhookKeyValue

- `key` (string, optional)
- `value` (string, optional)

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "your-webhook-id",
      "tenantId": "string",
      "name": "Webhook xử lý AI",
      "events": [
        "AI_TTS:COMPLETED",
        "AI_TTS:FAILED"
      ],
      "config": {
        "url": "https://yourdomain.com/webhooks",
        "method": "POST",
        "authType": "API_KEY",
        "apiKey": "my-secret-value",
        "hasApiKey": true,
        "headers": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "params": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "retryEnabled": true,
        "blockIfError": true,
        "blockAfterTimes": 0,
        "alertOnFailure": true,
        "alertOnRecovery": true
      },
      "status": "ENABLED",
      "createdAt": 1767225600000,
      "updatedAt": 1767225600000,
      "lastExecutedAt": 1767225600000,
      "blocked": false,
      "blockedUntil": 1,
      "errorCount": 0
    }
  ],
  "page": 1,
  "size": 1
}
```

**SDK Code**

```python
import requests

url = "https://api.omicx.one/webhooks/"

headers = {"X-Api-Key": "omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.omicx.one/webhooks/';
const options = {method: 'GET', headers: {'X-Api-Key': 'omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omicx.one/webhooks/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.omicx.one/webhooks/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = 'omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.omicx.one/webhooks/")
  .header("X-Api-Key", "omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.omicx.one/webhooks/', [
  'headers' => [
    'X-Api-Key' => 'omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.omicx.one/webhooks/");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Api-Key", "omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Api-Key": "omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.omicx.one/webhooks/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```