Chuyển tới nội dung
Sursa Developers

Sự kiện · Người dùng và quyền truy cập

api_key.created

Đã tạo khóa API

Một khóa API đã được tạo: khóa của tổ chức, khóa cá nhân hoặc khóa nguồn. Giá trị của khóa không bao giờ được gửi.

Loại đối tượng
api_key
Gửi tới
Webhook có vai trò admin

Payload

Đối tượng: EventApiKeyCreated

  • idstringbắt buộc

    ID sự kiện (evt_…), cũng được gửi trong header webhook-id. Dùng nó để loại bỏ các lần gửi trùng lặp.

  • typestringbắt buộc

    Giá trị cho phép: api_key.created

  • created_atstring (date-time)bắt buộc

    Thời điểm xảy ra thay đổi (UTC).

  • org_idintegerbắt buộc
  • api_versionstringbắt buộc

    Phiên bản hợp đồng của lược đồ data.

  • sequenceinteger

    Số thứ tự lần gửi trong phạm vi webhook (không có với sự kiện thử).

  • objectWebhookEventObjectbắt buộc
  • payloadstringbắt buộc

    thin nghĩa là không có data: hãy đọc đối tượng qua API.

    Giá trị cho phép: fullthin

  • dataobject
    Trường
    • api_keyEventAPIKeybắt buộc
    • actor_idinteger | nullbắt buộc

      Người dùng đã thực hiện hành động; null với khóa API của tổ chức hoặc chính nền tảng.

  • testbooleanbắt buộc

    Sự kiện thử được gửi bằng POST /v1/webhooks/{webhook_id}/test.

Ví dụ một lần gửi

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "api_key.created",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "api_key",
    "id": "14"
  },
  "payload": "full",
  "data": {
    "api_key": {
      "id": 14,
      "name": "CRM sync",
      "prefix": "kb_3f9a",
      "kind": "org",
      "role": "editor",
      "scopes": [
        "cards:read",
        "cards:write"
      ],
      "expires_at": "2026-10-31T00:00:00Z"
    },
    "actor_id": 7
  },
  "test": false
}

Nhận sự kiện

Mỗi lần gửi là một yêu cầu POST với phần thân JSON này tới webhook của bạn. Xác minh header webhook-signature (Standard Webhooks) trước khi tin vào phần thân, trả lời bằng trạng thái 2xx trong vài giây và xử lý công việc sau đó. Các lần gửi tới một webhook giữ đúng thứ tự sự kiện; lần gửi thất bại được thử lại với khoảng chờ tăng dần.

Loại sự kiện mới và trường mới có thể xuất hiện bất cứ lúc nào: hãy bỏ qua các loại và trường bạn không biết.

Các sự kiện này cũng có trong nguồn cấp sự kiện trong 30 ngày →