เอกสารอ้างอิง API

Webhook Endpoint

ลบ จุดเชื่อมต่อ Webhook

ลบ จุดเชื่อมต่อ Webhook การลบสำเร็จไม่มีเนื้อหาตอบกลับ

DELETEhttps://api.unifyport.ai/v1/webhook-endpoints/{endpoint_id}

ช่องทางที่รองรับ

all

ก่อนเรียกใช้

ใช้ X-Api-Key ของ workspace เจ้าของทรัพยากรบนเซิร์ฟเวอร์ แทนค่าตัวอย่างทั้งหมดก่อนเรียกใช้

พารามิเตอร์คำขอ

ส่วนหัว

X-Api-Key
stringจำเป็น

API key ของพื้นที่ทำงาน ระบบจะระบุพื้นที่ทำงานจากส่วนหัวนี้

พารามิเตอร์ใน path

endpoint_id
stringจำเป็น

ตัวระบุที่ใช้ใน route ของ webhook endpoints

พารามิเตอร์ Query

account_id
string

ID บัญชีสาธารณะที่ไม่บังคับ เช่น acc_example ห้ามเป็นสตริงว่าง มีแต่ช่องว่าง หรือระบุซ้ำ ต้องใช้ชื่อ account_id ตรงตัว หากใช้ตัวพิมพ์ใหญ่เล็กต่างกันจะคืน 400 invalid_request ไม่ถือว่าละไว้ ในการแสดงรายการ หากละไว้จะคืนเฉพาะ endpoint ของเวิร์กสเปซ หากระบุจะคืนเฉพาะการตั้งค่าอิสระของบัญชีนั้น (data=[] หากไม่มี โดยไม่รวมการตั้งค่าที่สืบทอดจากเวิร์กสเปซ) การดูรายละเอียด ปิดใช้งาน และลบจะตรวจสอบเฉพาะบัญชีเจ้าของเดิม หากไม่ตรงกันจะคืน 400 invalid_request หากบัญชีที่ระบุไม่มีอยู่หรือไม่อยู่ในเวิร์กสเปซปัจจุบันจะคืน 404 account_not_found (20020)

minLength: 1 · pattern: \S

เนื้อหาของคำขอ

จุดเชื่อมต่อนี้ไม่ต้องใช้เนื้อหา JSON

ทำความเข้าใจผลลัพธ์

ตั้งค่าสำเร็จไม่ได้ยืนยันว่าส่งเหตุการณ์แล้ว ให้สร้างเหตุการณ์และตรวจสอบการรับ ลายเซ็น และการตอบรับที่ปลายทาง

การตอบกลับ 204 No Content

ไม่มีเนื้อหาตอบกลับ

การตอบกลับ

204

204 No Content

คำขอสำเร็จ ไม่มีเนื้อหาตอบกลับ

400

Bad Request

เนื้อหาของคำขอ path หรือพารามิเตอร์ไม่ถูกต้อง

401

Unauthorized

ส่วนหัว X-Api-Key หายไปหรือไม่ถูกต้อง

404

Not Found

ไม่พบทรัพยากรของ provider ที่ร้องขอ

เมื่อคำขอล้มเหลว

ตรวจ HTTP และ error.code/numeric_code เก็บ request_id แล้วแก้พารามิเตอร์ ยืนยันตัวตนต่อ หรือตรวจ runtime ตามสาเหตุ ตรวจผลครั้งก่อนก่อนส่งหรือเขียนซ้ำ อ้างอิงรหัสข้อผิดพลาด

invalid_request · 10000 · 400
ตรวจฟิลด์บังคับ รูปแบบ และเงื่อนไขช่องทาง แล้วแก้คำขอ
invalid_api_key · 11001 · 401
ตรวจ X-Api-Key และว่า workspace ยังใช้งานอยู่