APIリファレンス：Webhook

送信Webhookは、ProcessMind内でイベントが発生したときに、指定したシステムへ通知を送ります。通知はすべて、Webhookシークレットで署名されたJSONのPOSTリクエストです。X-ProcessMind-Signatureヘッダーにはsha256=<hex>が含まれます。これはリクエスト本文の生データに対するHMAC-SHA256です。JSONを解析する前に、受信したバイト列そのものを使って署名を検証し、一致しない通知は拒否してください。各本文にはdeliveryIdも含まれます。これを使うと、少なくとも1回配信される通知の重複を排除できます。

送信Webhookの一覧を取得

エンドポイント： GET /v1/tenant/{tenantId}/webhooks

**認証：**テナントスコープのAPIキー・readスコープ

パラメーター：

名前	型	場所	必須	説明
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"
	}
]

エラー：

• 401APIキーがない、無効、停止中、または有効期限切れ

送信Webhookを作成（署名シークレットは1回のみ返されます）

エンドポイント： POST /v1/tenant/{tenantId}/webhooks

**認証：**テナントスコープのAPIキー・writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：uuid

リクエスト本文：

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

フィールド	型	必須	説明
url	string	はい	署名付きPOST通知を受信する公開httpsエンドポイント（プライベートアドレスおよびループバックアドレスは不可）
events	process.created | process.updated | process.deleted | mapping.created | data.ready | simulation.completed | webhook.test[]	はい	このWebhookへの通知を発生させるイベント
description	string	いいえ	説明（省略可） 最大長：500

レスポンス（201）：

Webhookを作成しました（署名シークレットを含む）

{
	"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	はい	署名シークレット。作成時のこのレスポンスでのみ返されます

エラー：

• 400不正なフィルター式、モデルのないプロセス、未対応のアップロード形式、必須項目の不足などによる不正なリクエスト
• 401APIキーがない、無効、停止中、または有効期限切れ

送信Webhookを1件取得

エンドポイント： GET /v1/tenant/{tenantId}/webhooks/{webhookId}

**認証：**テナントスコープのAPIキー・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

エラー：

• 401APIキーがない、無効、停止中、または有効期限切れ
• 404リソースが見つかりません

送信Webhookを更新

エンドポイント： PUT /v1/tenant/{tenantId}/webhooks/{webhookId}

**認証：**テナントスコープのAPIキー・writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：uuid
webhookId	string	path	はい	形式：uuid

リクエスト本文：

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

フィールド	型	必須	説明
url	string	いいえ	署名付きPOST通知を受信する公開httpsエンドポイント
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

エラー：

• 401APIキーがない、無効、停止中、または有効期限切れ
• 404リソースが見つかりません

送信Webhookを削除

エンドポイント： DELETE /v1/tenant/{tenantId}/webhooks/{webhookId}

**認証：**テナントスコープのAPIキー・writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：uuid
webhookId	string	path	はい	形式：uuid

レスポンス（200）：

Webhookを削除しました

{
	"deleted": true
}

フィールド	型	必須	説明
deleted	boolean	はい

エラー：

• 401APIキーがない、無効、停止中、または有効期限切れ
• 404リソースが見つかりません

Webhookにテスト通知を送信

エンドポイント： POST /v1/tenant/{tenantId}/webhooks/{webhookId}/test

**認証：**テナントスコープのAPIキー・writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：uuid
webhookId	string	path	はい	形式：uuid

レスポンス（200）：

テスト通知を送信しました

{
	"message": "string"
}

フィールド	型	必須	説明
message	string	はい

エラー：

• 401APIキーがない、無効、停止中、または有効期限切れ
• 404リソースが見つかりません