管理者Webhook API

POSTウェブフック

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

webhooksエンドポイントへのPOSTクエリにより、新しいWebhookが作成されます。

警告

Webhookを作成するときは、HTTPではなくHTTPS URIを使用する必要があります。

相対ルート	/webhooks
HTTP Verb	POST

体

本体の構造は次のとおりです。

{
  "label": "My new webhook",
  "createdBy": "anco",
  "uri": "https://localhost",
  "method": "GET",
  "headers": {
    "X-Custom-Header1":"foo"
  },
  "body": "bar"
}

応答

POSTクエリは、次のように構造化された新しいWebhookの詳細を返します。

{
  "id": "12345",
  "tenantId": "test-tenant",
  "label": "My new webhook",
  "uri": "https://localhost/",
  "method": "GET",
  "headers": {
    "X-Custom-Header1": "foo"
  },
  "body": "bar",
  "createdBy": "anco",
  "created": "2021-03-26T11:31:23.894452+00:00"
}

新しいWebhookの場所は、応答ヘッダーで確認できます。

クエリが成功すると、createdステータスコード (201) が返されます。

この記事を改善するための提案がある場合は、お知らせください!