APIリファレンス：Webhooks

送信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	パス	はい	形式：uuid
limit	integer	クエリ	いいえ	返す項目の最大数
offset	integer	クエリ	いいえ	スキップする項目数

レスポンス（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キーがない、無効、無効化済み、または期限切れ

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

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：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 不正なリクエスト：無効なフィルター式、モデルのないプロセス、サポートされていないアップロード形式、必須フィールドの欠落など
• 401 APIキーがない、無効、無効化済み、または期限切れ

送信Webhookを1件取得

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：uuid
webhookId	string	パス	はい	形式：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キーがない、無効、無効化済み、または期限切れ
• 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

エラー：

• 401 APIキーがない、無効、無効化済み、または期限切れです
• 404 リソースが見つかりません

送信Webhookを削除

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

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

パラメーター：

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

レスポンス（200）：

Webhookを削除しました

{
	"deleted": true
}

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

エラー：

• 401 APIキーがない、無効、無効化済み、または期限切れです
• 404 リソースが見つかりません

Webhookへのテスト納品をトリガー

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

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

パラメーター：

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

レスポンス（200）：

テスト納品をトリガーしました

{
	"message": "string"
}

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

エラー：

• 401 APIキーがない、無効、無効化済み、または期限切れです
• 404 リソースが見つかりません