Webhook の管理—Portal for ArcGIS | ArcGIS Enterprise のドキュメント

管理者は、構成を更新したり (Webhook が登録されているイベントトリガーを更新するなど)、以前に構成された Webhook を無効にしたり削除したりすることによって、Webhook を更新および管理することができます。

Webhook の更新

Webhook を作成した後で、Webhook に構成されているパラメーターを更新することができます。以下の各セクションでは、組織 Webhook とサービス Webhook を更新する方法について説明します。

Organization Webhook の更新

ArcGIS Enterprise ポータル Web サイトから組織 Webhook を更新するには、次の手順を実行します。

デフォルトの管理者または組織 Webhook を作成および管理するための管理権限を持つカスタムロールのメンバーとしてサインインしていることを確認します。
[組織] > [設定] > [Webhook] の順に参照します。
[組織 Webhook] で、更新する Webhook を見つけます。
[オプション] ボタンをクリックし、[編集] をクリックします。
[Webhook の編集] ウィンドウで、以下を変更します。
1. Webhook 名を更新するには、[Name] テキストボックスに Webhook の一意の名前を入力します。
2. Webhook タイプを更新するには、[タイプ] ドロップダウンメニューをクリックし、新しい Webhook タイプを選択します。
  - [すべて] を選択すると、サポートされているすべてのイベントトリガーに登録されます。各イベントが発生すると通知を受けます。
  - [アイテム]、[ユーザー]、[グループ]、または [ロール] を選択すると、登録するトリガーイベントを手動で定義することができます。
3. [すべて] 以外の Webhook タイプを選択すると、選択した Webhook タイプに関連する追加のドロップダウンメニューが表示されます。たとえば、Webhook タイプに [アイテム] を選択すると [アイテム] ドロップダウンメニューが表示され、Webhook が監視する特定のアイテムを選択できます。
4. イベントトリガーを更新するには、[イベント] ドロップダウンメニューをクリックし、新しいトリガーイベントを選択します。たとえば、特定のアイテムが公開された時点で Webhook を呼び出す場合は、「/items/<アイテム ID>/publish」を選択します。
5. ペイロード URL を更新する必要がある場合は、[Webhook URL] を選択し、Webhook レシーバーの新しいペイロード URL を入力します。
6. ノートブックアイテムを更新する必要がある場合は、[ノートブック] を選択し、Webhook がトリガーされた時点で実行される新しいノートブックを選択します。
7. 必要に応じて、[シークレット (オプション)] テキストボックスで、Webhook のシークレットとして機能する英数字文字列を追加するか、既存のシークレットを更新します。シークレット値は Webhook ペイロードヘッダーに含まれる署名を生成するために使用されます。 Webhook レシーバーはこの署名を使用し、メッセージを信頼できるかどうかを判断します。
[Webhook の更新] をクリックして、変更した内容を適用します。

サービス Webhook の更新

サービス Webhook のプロパティを更新するには、次の手順に従います。

デフォルトの管理者またはサービス Webhook を作成および管理するための管理権限を持つカスタムロールのメンバーとしてサインインしていることを確認します。
注意:
公開者のロールが割り当てられたメンバーは、ArcGIS Enterprise ポータルサイトからサービス Webhook を作成または管理できないので、管理 API を使用してワークフローを実行します。
[組織] > [設定] > [Webhook] の順に参照します。
[サービス Webhook] で、更新する Webhook を見つけます。
[オプション] ボタンをクリックし、[編集] をクリックします。
[Webhook の編集] ウィンドウで、以下を変更します。
1. Webhook 名を更新するには、[Name] テキストボックスに Webhook の一意の名前を入力します。
2. Webhook が関連付けられたサービスを更新するには、[サービス] ドロップダウンメニューをクリックし、新しいサービスを選択します。
  注意:
  ジオプロセシングサービスを選択すると、イベントが [サービス完了] として設定されます。フィーチャサービスを選択すると [イベント] ドロップダウンメニューが有効になります。
3. フィーチャサービス Webhook を選択する場合、[イベント] ドロップダウンメニューから新しいイベントトリガーを選択します。たとえば、フィーチャアタッチメントを更新したときに Webhook を呼び出すには、「AttachmentsUpdated」を選択します。
4. ペイロード URL を更新する必要がある場合は、[Webhook URL] を選択し、Webhook レシーバーの新しいペイロード URL を入力します。
5. 必要に応じて、[シークレット (オプション)] テキストボックスで、Webhook のシークレットとして機能する英数字文字列を追加するか、既存のシークレットを更新します。シークレット値は Webhook ペイロードヘッダーに含まれる署名を生成するために使用されます。 Webhook レシーバーはこの署名を使用し、メッセージを信頼できるかどうかを判断します。
[Webhook の更新] をクリックして、変更した内容を適用します。

Webhook の非アクティブ化

Webhook は手動で非アクティブ化するか、非アクティブ化ポリシーが満たされたときに非アクティブ化できます。 Webhook が非アクティブ化すると、その Webhook は一時停止し、トリガーされたときにペイロードを配信できなくなります。以下の各セクションでは、組織 Webhook とサービス Webhook を非アクティブ化する方法について説明します。

Organization Webhook の非アクティブ化

ArcGIS Enterprise ポータル Web サイトから組織 Webhook を非アクティブ化するには、次の手順を実行します。

デフォルトの管理者または組織 Webhook を作成および管理するための管理権限を持つカスタムロールのメンバーとしてサインインしていることを確認します。
[組織] > [設定] > [Webhook] の順に参照します。
[組織 Webhook] で非アクティブ化する組織 Webhook を見つけ、[アクティブ] をクリックします。
[確認] をクリックして、Webhook を一時停止します。

サービス Webhook の非アクティブ化

サービス Webhook を非アクティブ化するには、次の手順に従います。

デフォルトの管理者またはサービス Webhook を作成および管理するための管理権限を持つカスタムロールのメンバーとしてサインインしていることを確認します。
注意:
公開者のロールが割り当てられたメンバーは、ArcGIS Enterprise ポータルサイトからサービス Webhook を作成または管理できないので、管理 API を使用してワークフローを実行します。
[組織] > [設定] > [Webhook] の順に参照します。
[サービス Webhook] で非アクティブ化するサービス Webhook を見つけ、[アクティブ] をクリックします。
[確認] をクリックして、Webhook を一時停止します。

Webhook のアクティブ化

Webhook は非アクティブ化されている間、ペイロードを配信することができません。 Webhook を再びアクティブ化すると Webhook が再開し、その Webhook が次に呼び出されたときにペイロードを配信できるようになります。以下の各セクションでは、先ほど非アクティブ化した組織 Webhook とサービス Webhook をアクティブ化する方法について説明します。

Organization Webhook のアクティブ化

ArcGIS Enterprise ポータル Web サイトから組織 Webhook をアクティブ化するには、次の手順を実行します。

デフォルトの管理者または組織 Webhook を作成および管理するための管理権限を持つカスタムロールのメンバーとしてサインインしていることを確認します。
[組織] > [設定] > [Webhook] の順に参照します。
[組織 Webhook] でアクティブ化する組織 Webhook を見つけ、[非アクティブ] をクリックします。
[確認] をクリックして Webhook を再開します。

サービス Webhook のアクティブ化

サービス Webhook をアクティブ化するには、次の手順に従います。

デフォルトの管理者またはサービス Webhook を作成および管理するための管理権限を持つカスタムロールのメンバーとしてサインインしていることを確認します。
注意:
公開者のロールが割り当てられたメンバーは、ArcGIS Enterprise ポータルサイトからサービス Webhook を作成または管理できないので、管理 API を使用してワークフローを実行します。
[組織] > [設定] > [Webhook] の順に参照します。
[サービス Webhook] でアクティブ化するサービス Webhook を見つけ、[非アクティブ] をクリックします。
[確認] をクリックして Webhook を再開します。

Webhook の削除

以前に作成された Webhook が不要になった場合、Webhook を削除することで組織から完全に削除することができます。以下の各セクションでは、組織 Webhook とサービス Webhook を削除する方法について説明します。

Organization Webhook の削除