OMICX Documentation

curl -X POST https://api.omicx.one/webhooks/ \
     -H "X-Api-Key: omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
     -H "Content-Type: application/json" \
     -d '{
  "events": [
    "AI_TTS:COMPLETED",
    "AI_TTS:FAILED"
  ],
  "config": {
    "url": "https://yourdomain.com/webhooks",
    "method": "POST",
    "authType": "API_KEY",
    "apiKey": "my-secret-value",
    "retryEnabled": true,
    "blockIfError": true,
    "alertOnFailure": true,
    "alertOnRecovery": true
  },
  "name": "Webhook xử lý AI"
}'

{
  "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
}

Đăng ký một endpoint HTTP để nhận payload sự kiện (xem danh mục sự kiện). Các giá trị xác thực bí mật (config.apiKey, giá trị custom header) chỉ ghi (write-only) — response chỉ trả về hasApiKey hoặc giá trị đã che (masked). URL đích phải là endpoint http(s) công khai (có chống SSRF). Scope yêu cầu: webhook:write.

Đăng ký một endpoint HTTP để nhận payload sự kiện (xem danh mục sự kiện). Các giá trị xác thực bí mật (`config.apiKey`, giá trị custom header) chỉ ghi (write-only) — response chỉ trả về `hasApiKey` hoặc giá trị đã che (masked). URL đích phải là endpoint http(s) công khai (có chống SSRF). **Scope yêu cầu:** `webhook:write`.

Request

This endpoint expects an object.

eventslist of stringsRequired

Sự kiện đăng ký — dạng "{TYPE}:{ACTION}" (ví dụ "AI_TTS:COMPLETED") hoặc chỉ "{TYPE}" ở những nơi hỗ trợ. Xem đầy đủ tại API Danh mục sự kiện.

configobjectRequired

namestringOptional<=200 characters

Tên hiển thị.

Response

Webhook đã tạo (giá trị bí mật đã che).

idstring

tenantIdstring

namestring

eventslist of strings

configobject

statusenum

createdAtlong

updatedAtlong

lastExecutedAtlong or null

blockedboolean

Lượt gửi tới webhook này có đang bị tạm giữ do chặn lỗi hay không.

blockedUntillong or null

Epoch millis khi trạng thái chặn hết hạn (chỉ có khi đang bị chặn).

errorCountlong

Số lần lỗi trong cửa sổ trượt hiện tại.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

502

Bad Gateway Error

Tạo Webhook

Headers

Request

Response

Errors