OMICX Documentation

curl -X PUT 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"
  },
  "id": "your-webhook-id"
}'

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

Cập nhật toàn bộ (id nằm trong body). Với authType: API_KEY, để trống config.apiKey để giữ nguyên key đã lưu. 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

idstringRequired

ID webhook cần cập nhật.

namestringOptional<=200 characters

Tên hiển thị.

Response

Webhook đã cập nhật (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

404

Not Found Error

502

Bad Gateway Error

Cập nhật Webhook

Headers

Request

Response

Errors