API から Webhook を更新する
API から Webhook を更新するには、更新するパラメーターを使用して Webhook の API エンドポイントに PUT コマンドを送信します。
POST構造のサンプルについては、「組織 Webhook の更新」または「サイト Webhook の更新」を参照してください。応答の例を以下に示します。
以下は、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
}
この Webhook に変更を加える場合は、API クライアントから Webhook API URL /api/v1/orgs/{org_id}/webhooks/{webhook_id} への (PUT) API 呼び出しを、リクエスト本文で更新された構成で行う必要があります。
次の例では、id 4ec10796-16ec-4225-aba4-xxxxxxxxxxxx を持つ Webhook の設定を表示 (GET)、更新 (PUT)、または削除 (DELETE) する URL は次のとおりです。
https://{api-host}/api/v1/orgs/3f12cb79-fb5e-4d4b-xxxx-xxxxxxxxxxxxx/webhooks/4ec10796-16ec-4225-aba4-xxxxxxxxxxxx
手記：
{api-host} の代わりに、グローバルリージョンの API ホスト (またはエンドポイント) を使用します。 「APIエンドポイントとグローバルリージョン」を参照してください。
そこで、Webhook レシーバーの URL を https://enicxxxx72vx.x.pipedream.net に変更するとします。これを行うには、上記の Webhook API エンドポイントを次の要求本文で更新 (PUT) する必要があります。
{
"url":"https://enicxxxx72vx.x.pipedream.net"
}