ข้ามไปยังเนื้อหา
Sursa Developers

อีเวนต์ · บุคคลและสิทธิ์เข้าถึง

api_key.expiring

คีย์ API ใกล้หมดอายุ

คีย์ API จะหมดอายุภายใน 7 วัน อีเวนต์นี้ส่งครั้งเดียวต่อวันหมดอายุหนึ่งวัน

ประเภทออบเจ็กต์
api_key
ส่งถึง
เว็บฮุกที่มีบทบาท admin

เพย์โหลด

ออบเจ็กต์: EventApiKeyExpiring

  • idstringจำเป็น

    ID ของอีเวนต์ (evt_…) ส่งเป็นเฮดเดอร์ webhook-id ด้วย ใช้ค่านี้เพื่อทิ้งการส่งที่ซ้ำ

  • typestringจำเป็น

    ค่าที่ใช้ได้: api_key.expiring

  • created_atstring (date-time)จำเป็น

    เวลาที่เกิดการเปลี่ยนแปลง (UTC)

  • org_idintegerจำเป็น
  • api_versionstringจำเป็น

    เวอร์ชันของสัญญา API ของสคีมา data

  • sequenceinteger

    หมายเลขลำดับการส่งภายในเว็บฮุก (ไม่มีสำหรับอีเวนต์ทดสอบ)

  • objectWebhookEventObjectจำเป็น
  • payloadstringจำเป็น

    thin หมายถึงไม่มี data: ให้อ่านออบเจ็กต์ผ่าน API

    ค่าที่ใช้ได้: fullthin

  • dataobject
    ฟิลด์
    • api_keyEventAPIKeyจำเป็น
    • days_leftintegerจำเป็น

      จำนวนวันที่เหลือก่อนคีย์หมดอายุ

  • testbooleanจำเป็น

    อีเวนต์ทดสอบที่ส่งโดย POST /v1/webhooks/{webhook_id}/test

ตัวอย่างการส่ง

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "api_key.expiring",
  "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"
    },
    "days_left": 6
  },
  "test": false
}

การรับอีเวนต์

การส่งแต่ละครั้งเป็นคำขอ POST ที่มีเนื้อหา JSON นี้ไปยังเว็บฮุกของคุณ ตรวจลายเซ็นในเฮดเดอร์ webhook-signature (Standard Webhooks) ก่อนเชื่อถือเนื้อหา ตอบกลับด้วยสถานะ 2xx ภายในไม่กี่วินาที แล้วจึงประมวลผลภายหลัง การส่งไปยังเว็บฮุกเดียวกันคงลำดับของอีเวนต์ไว้ และการส่งที่ล้มเหลวจะลองส่งใหม่โดยเว้นระยะนานขึ้นทุกครั้ง

อาจมีประเภทอีเวนต์ใหม่และฟิลด์ใหม่เพิ่มเข้ามาได้ทุกเมื่อ ให้ข้ามประเภทและฟิลด์ที่ไม่รู้จัก

อีเวนต์เดียวกันนี้อยู่ในฟีดอีเวนต์เป็นเวลา 30 วัน →