Referensi API: Webhook

Webhook keluar memberi tahu sistem Anda saat terjadi peristiwa di ProcessMind. Setiap pengiriman berupa JSON POST yang ditandatangani dengan secret webhook Anda. Header X-ProcessMind-Signature berisi sha256=<hex>, yaitu HMAC-SHA256 dari isi permintaan mentah. Verifikasi tanda tangan menggunakan byte persis seperti yang diterima, sebelum mengurai JSON, lalu tolak pengiriman jika tanda tangannya tidak cocok. Setiap isi permintaan juga menyertakan deliveryId yang dapat digunakan untuk menghapus duplikasi pada pengiriman yang mungkin diterima lebih dari sekali.

Lihat daftar webhook keluar

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

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
limit	integer	query	Tidak	Jumlah maksimum item yang dikembalikan
offset	integer	query	Tidak	Jumlah item yang dilewati

Respons (200):

Daftar webhook

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

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa

Buat webhook keluar (secret penanda tangan hanya dikembalikan sekali)

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

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid

Isi permintaan:

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

Field	Tipe	Wajib	Deskripsi
url	string	Ya	Endpoint https publik yang menerima pengiriman POST bertanda tangan (alamat privat atau loopback tidak diizinkan)
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ya	Peristiwa yang memicu pengiriman ke webhook ini
description	string	Tidak	Deskripsi opsional Panjang maksimum: 500

Respons (201):

Webhook dibuat (termasuk secret penanda tangan)

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

Field	Tipe	Wajib	Deskripsi
id	string	Ya	Format: uuid
url	string	Ya	Format: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ya
description	string	Ya	Panjang maksimum: 500
isActive	boolean	Ya	Default: true
createdAt	string	Ya	Format: date-time
secret	string	Ya	Secret penanda tangan; hanya dikembalikan di sini saat webhook dibuat

Error:

• 400 Permintaan tidak valid: misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan yang tidak didukung, atau kolom wajib yang belum diisi
• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa

Melihat detail webhook keluar

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

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama	Jenis	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
webhookId	string	path	Ya	Format: uuid

Respons (200):

Webhook

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

Kolom	Jenis	Wajib	Deskripsi
id	string	Ya	Format: uuid
url	string	Ya	Format: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ya
description	string	Ya	Panjang maksimum: 500
isActive	boolean	Ya	Default: true
createdAt	string	Ya	Format: date-time

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404 Sumber daya tidak ditemukan

Memperbarui webhook keluar

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

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Jenis	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
webhookId	string	path	Ya	Format: uuid

Isi permintaan:

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

Kolom	Jenis	Wajib	Deskripsi
url	string	Tidak	Endpoint https publik yang menerima pengiriman POST bertanda tangan
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Tidak	Peristiwa yang memicu pengiriman ke webhook ini
description	string	Tidak	Deskripsi opsional Panjang maksimum: 500
isActive	boolean	Tidak	Menentukan apakah webhook diaktifkan

Respons (200):

Webhook diperbarui

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

Kolom	Jenis	Wajib	Deskripsi
id	string	Ya	Format: uuid
url	string	Ya	Format: uri
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	Ya
description	string	Ya	Panjang maksimum: 500
isActive	boolean	Ya	Default: true
createdAt	string	Ya	Format: date-time

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404 Sumber daya tidak ditemukan

Menghapus webhook keluar

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

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Jenis	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
webhookId	string	path	Ya	Format: uuid

Respons (200):

Webhook dihapus

{
	"deleted": true
}

Kolom	Jenis	Wajib	Deskripsi
deleted	boolean	Ya

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404 Sumber daya tidak ditemukan

Mengirim pengujian ke webhook

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

Autentikasi: API key khusus tenant · cakupan write

Parameter:

Nama	Jenis	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: uuid
webhookId	string	path	Ya	Format: uuid

Respons (200):

Pengiriman pengujian dimulai

{
	"message": "string"
}

Kolom	Jenis	Wajib	Deskripsi
message	string	Ya

Error:

• 401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
• 404 Sumber daya tidak ditemukan