本文へ移動

API ドキュメント

v1.0.0

Webhook の作成

POST /api/v1/webhooks

スコープ:webhooks:manage 無料

https の URL と受信したいイベントを指定します。署名用シークレットはこの応答にのみ含まれます。

ボディ

ボディ
名前型説明
url 必須

公開 https URL

string公開 https URL
events 必須

受信するイベント

enum[]受信するイベント case.created, case.status_changed, report.published, report.processed, value.corrected, value.conflict, portfolio.hit, auction.linked
enabled

Webhook のオン/オフ

booleanWebhook のオン/オフ

応答、HTTP 201

応答、HTTP 201

応答、HTTP 201
名前型説明
data 必須 object
data.secret 必須 string

応答、HTTP 422

Validation error

応答、HTTP 422

応答、HTTP 422
名前型説明
error 必須 object
error.code 必須

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.message 必須

Human-readable explanation

stringHuman-readable explanation
error.details

Extra information, such as the fields that failed validation

objectExtra information, such as the fields that failed validation

応答のフィールドは openapi.json に記載されています。各値が出典とともにどのように構成されているかは、次をご覧ください: データと出典文書