API からウェブフックを更新する
API からウェブフックを更新するには、更新するトピックパラメータを使用して、ウェブフックの API に PUT コマンドを送信します。
以下は、API から見た既存の組織レベルの mxedge-events Webhook の設定例です。
[
{
"enabled": true,
"name": "mist-edge",
"url": "https://webhook.site/4ec10796-16ec-4225-aba4-xxxxxxxxxxxx",
"secret": "",
"topics": [
"mxedge-events"
],
"verify_cert": true,
"id": "a7c61a9c-a25b-4c27-xxxx-xxxxxxxxxxxx",
"for_site": false,
"site_id": "00000000-0000-0000-0000-000000000000",
"org_id": "3f12cb79-fb5e-4d4b-xxxx-xxxxxxxxxxxx",
"created_time": 1575305516,
"modified_time": 1692974137
}
]
このウェブフックに変更を加える場合は、API クライアントから目的の API URL に対して API 呼び出し (PUT) を行う必要があります。この例では、API は組織用に構成されたすべての Webhook を表示するための URL です。 https://<api-endpoint>/api/v1/orgs/3f12cb79-fb5e-4d4b-xxxx-xxxxxxxxxxxxx/webhooks
手記：
<api-endpoint> の代わりに、グローバルリージョンの API エンドポイントを使用します。 「API エンドポイントとグローバルリージョン」を参照してください。
Webhook の一意のidと、変更する構成項目を含める必要があります。この例では、Webhook レシーバーの URL を https://enicxxxx72vx.x.pipedream.net に変更します。これを行うには、組織の Web API にスパース フィールドセットとして表示されるurlと Webhook ID を指定して、Webhook を更新 (PUT) する必要があります。
PUT
https://api.mist.com/api/v1/orgs/3f12cb79-fb5e-4d4b-xxxx-xxxxxxxxxxxxx/webhooks - {"enabled":true,"name":"mist-edge","url":"https://webhook.site/4ec10796-16ec-4225-aba4-b3ebaed32750","id":"a7c61a9c-a25b-4c27-xxxx-xxxxxxxxxxxxx","org_id":"3f12cb79-fb5e-4d4b-xxxx-xxxxxxxxxxxx"}