อีเวนต์ · การเรียกเก็บเงิน
credits.low
เครดิตใกล้หมด
ยอดเครดิตของรอบระยะเวลาผ่านเกณฑ์การใช้งาน (data.threshold คือเปอร์เซ็นต์ของโควตาที่ใช้ไป) ส่งครั้งเดียวต่อเกณฑ์และรอบระยะเวลา
- ประเภทออบเจ็กต์
- org
- ส่งถึง
- เว็บฮุกที่มีบทบาท admin
เพย์โหลด
idstringจำเป็นID ของอีเวนต์ (
evt_…) ส่งเป็นเฮดเดอร์webhook-idด้วย ใช้ค่านี้เพื่อทิ้งการส่งที่ซ้ำtypestringจำเป็นค่าที่ใช้ได้:
credits.lowcreated_atstring (date-time)จำเป็นเวลาที่เกิดการเปลี่ยนแปลง (UTC)
org_idintegerจำเป็นapi_versionstringจำเป็นเวอร์ชันของสัญญา API ของสคีมา
datasequenceintegerหมายเลขลำดับการส่งภายในเว็บฮุก (ไม่มีสำหรับอีเวนต์ทดสอบ)
payloadstringจำเป็นthinหมายถึงไม่มีdata: ให้อ่านออบเจ็กต์ผ่าน APIค่าที่ใช้ได้:
fullthindataobjectฟิลด์
thresholdintegerจำเป็นเกณฑ์เป็นร้อยละของเครดิตที่ใช้ไปจากที่ได้รับ: 80 หรือ 100
period_startstring (date)จำเป็นbalancenumberallowancenumber
testbooleanจำเป็นอีเวนต์ทดสอบที่ส่งโดย
POST /v1/webhooks/{webhook_id}/test
ตัวอย่างการส่ง
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "credits.low",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "org",
"id": "1"
},
"payload": "full",
"data": {
"threshold": 80,
"period_start": "2026-10-01",
"balance": 1000,
"allowance": 5000
},
"test": false
}การรับอีเวนต์
การส่งแต่ละครั้งเป็นคำขอ POST ที่มีเนื้อหา JSON นี้ไปยังเว็บฮุกของคุณ ตรวจลายเซ็นในเฮดเดอร์ webhook-signature (Standard Webhooks) ก่อนเชื่อถือเนื้อหา ตอบกลับด้วยสถานะ 2xx ภายในไม่กี่วินาที แล้วจึงประมวลผลภายหลัง การส่งไปยังเว็บฮุกเดียวกันคงลำดับของอีเวนต์ไว้ และการส่งที่ล้มเหลวจะลองส่งใหม่โดยเว้นระยะนานขึ้นทุกครั้ง
อาจมีประเภทอีเวนต์ใหม่และฟิลด์ใหม่เพิ่มเข้ามาได้ทุกเมื่อ ให้ข้ามประเภทและฟิลด์ที่ไม่รู้จัก