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

Webhook ขาออกจะแจ้งระบบของคุณเมื่อมีเหตุการณ์เกิดขึ้นใน ProcessMind การส่งแต่ละครั้งเป็น JSON POST ที่ลงลายเซ็นด้วย webhook secret ของคุณ โดย header X-ProcessMind-Signature จะมีค่า sha256=<hex> ซึ่งเป็น HMAC-SHA256 ที่คำนวณจาก body ของคำขอดิบ ให้ตรวจสอบลายเซ็นกับไบต์ที่ได้รับโดยตรงก่อนแยกวิเคราะห์ JSON และปฏิเสธการส่งที่ลายเซ็นไม่ตรงกัน ใน body แต่ละรายการยังมี deliveryId ซึ่งใช้ป้องกันการประมวลผลซ้ำได้ เนื่องจากระบบอาจส่งซ้ำอย่างน้อยหนึ่งครั้ง.

แสดงรายการ webhook ขาออก

Endpoint: GET /v1/tenant/{tenantId}/webhooks

การยืนยันตัวตน: API key ที่กำหนดขอบเขตตาม tenant · read scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
limit	integer	query	ไม่	จำนวนรายการสูงสุดที่ส่งคืน
offset	integer	query	ไม่	จำนวนรายการที่ข้ามไป

คำตอบ (200):

รายการ webhook

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"url": "string",
		"events": [
			"process.created"
		],
		"description": "string",
		"isActive": true,
		"createdAt": "2024-03-15T16:30:00Z"
	}
]

ข้อผิดพลาด:

• 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ

สร้าง webhook ขาออก (ส่งคืน signing secret เพียงครั้งเดียว)

Endpoint: POST /v1/tenant/{tenantId}/webhooks

การยืนยันตัวตน: API key ที่กำหนดขอบเขตตาม tenant · write scope

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid

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

{
	"url": "string",
	"events": [
		"process.created"
	],
	"description": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
url	string	ใช่	endpoint https สาธารณะที่รับการส่ง POST ซึ่งลงลายเซ็นแล้ว (ห้ามใช้ที่อยู่ private หรือ loopback)
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	ใช่	เหตุการณ์ที่ทำให้ webhook นี้ส่งข้อมูล
description	string	ไม่	คำอธิบาย (ไม่บังคับ) ความยาวสูงสุด: 500

คำตอบ (201):

สร้าง webhook แล้ว (มี signing secret)

{
	"id": "00000000-0000-0000-0000-000000000000",
	"url": "string",
	"events": [
		"process.created"
	],
	"description": "string",
	"isActive": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"secret": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
url	string	ใช่	รูปแบบ: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	ใช่
description	string	ใช่	ความยาวสูงสุด: 500
isActive	boolean	ใช่	ค่าเริ่มต้น: true
createdAt	string	ใช่	รูปแบบ: date-time
secret	string	ใช่	signing secret ซึ่งส่งคืนเฉพาะที่นี่ในขั้นตอนสร้าง

ข้อผิดพลาด:

• 400 คำขอไม่ถูกต้อง เช่น นิพจน์ตัวกรองไม่ถูกต้อง กระบวนการไม่มีโมเดล ประเภทไฟล์ที่อัปโหลดไม่รองรับ หรือไม่มีฟิลด์ที่จำเป็น
• 401ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ

ดูรายละเอียด webhook ขาออก

Endpoint: GET /v1/tenant/{tenantId}/webhooks/{webhookId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม Tenant · ขอบเขต read

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
webhookId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

Webhook

{
	"id": "00000000-0000-0000-0000-000000000000",
	"url": "string",
	"events": [
		"process.created"
	],
	"description": "string",
	"isActive": true,
	"createdAt": "2024-03-15T16:30:00Z"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
url	string	ใช่	รูปแบบ: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	ใช่
description	string	ใช่	ความยาวสูงสุด: 500
isActive	boolean	ใช่	ค่าเริ่มต้น: true
createdAt	string	ใช่	รูปแบบ: date-time

ข้อผิดพลาด:

• 401ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404ไม่พบทรัพยากร

แก้ไข webhook ขาออก

Endpoint: PUT /v1/tenant/{tenantId}/webhooks/{webhookId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม Tenant · ขอบเขต write

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
webhookId	string	path	ใช่	รูปแบบ: uuid

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

{
	"url": "string",
	"events": [
		"process.created"
	],
	"description": "string",
	"isActive": true
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
url	string	ไม่	Endpoint https สาธารณะที่รับการส่ง POST พร้อมลายเซ็น
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	ไม่	เหตุการณ์ที่ทำให้มีการส่งข้อมูลไปยัง webhook นี้
description	string	ไม่	คำอธิบายเพิ่มเติม ความยาวสูงสุด: 500
isActive	boolean	ไม่	ระบุว่าเปิดใช้งาน webhook หรือไม่

การตอบกลับ (200):

อัปเดต webhook แล้ว

{
	"id": "00000000-0000-0000-0000-000000000000",
	"url": "string",
	"events": [
		"process.created"
	],
	"description": "string",
	"isActive": true,
	"createdAt": "2024-03-15T16:30:00Z"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
id	string	ใช่	รูปแบบ: uuid
url	string	ใช่	รูปแบบ: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	ใช่
description	string	ใช่	ความยาวสูงสุด: 500
isActive	boolean	ใช่	ค่าเริ่มต้น: true
createdAt	string	ใช่	รูปแบบ: date-time

ข้อผิดพลาด:

• 401ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404ไม่พบทรัพยากร

ลบ webhook ขาออก

Endpoint: DELETE /v1/tenant/{tenantId}/webhooks/{webhookId}

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม Tenant · ขอบเขต write

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
webhookId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

ลบ webhook แล้ว

{
	"deleted": true
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
deleted	boolean	ใช่

ข้อผิดพลาด:

• 401ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404ไม่พบทรัพยากร

ส่งการทดสอบไปยัง webhook

Endpoint: POST /v1/tenant/{tenantId}/webhooks/{webhookId}/test

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม Tenant · ขอบเขต write

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

ชื่อ	ประเภท	ตำแหน่ง	จำเป็น	คำอธิบาย
tenantId	string	path	ใช่	รูปแบบ: uuid
webhookId	string	path	ใช่	รูปแบบ: uuid

การตอบกลับ (200):

เริ่มส่งการทดสอบแล้ว

{
	"message": "string"
}

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
message	string	ใช่

ข้อผิดพลาด:

• 401ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
• 404ไม่พบทรัพยากร