Erstellen von Webhooks

Als Organisationsadministrator können Sie Webhooks für die ArcGIS Enterprise-Bereitstellung konfigurieren, um eine Benachrichtigung zu erhalten, wenn bestimmte Ereignisse eingetreten sind. In den folgenden Abschnitten wird beschrieben, wie Sie Organisations- und Service-Webhooks konfigurieren.

Voraussetzungen für das Erstellen von Webhooks

Beachten Sie vor dem Erstellen von Webhooks Folgendes:

• In der Organisation muss ArcGIS Enterprise 10.7 oder höher verwendet werden, damit Organisations-Webhooks verwendet werden können. In der Organisation muss ArcGIS Enterprise 11.0 oder höher verwendet werden, damit Service-Webhooks verwendet werden können.
• Sie müssen Administrator sein oder Ihnen muss die Standard-Administratorrolle zugewiesen sein, damit Sie Organisations-Webhooks erstellen und verwalten können.
• Ihnen müssen die Administratorberechtigungen "Aktualisieren", "Löschen", "Sicherheit und Infrastruktur" oder "Server" oder die Standard-Administratorrolle zugewiesen sein, damit Sie Service-Webhooks erstellen und verwalten können.
• Webhook-Empfänger müssen für die Kommunikation über eine HTTPS-Verbindung konfiguriert sein. Einige Optionen werden für Empfänger unterstützt, z. B. Web-Service-Empfänger von Drittanbietern (Microsoft Power Automate, Zapier und IFFT), benutzerdefinierte Web-Services, ArcGIS Notebook Server und ArcGIS Workflow Manager. Beispiele zum Erstellen von benutzerdefinierten Web-Services sowie eine Einführung in die Verwendung von Drittanbieter-Empfängern finden Sie im Webhook-Repository. Weitere Informationen zum Erstellen von Notebook Server- und Workflow Manager-Webhooks finden Sie in den jeweiligen Themen Automatisieren von Workflows mit ArcGIS Notebooks und Erstellen von Aufträgen mit Webhooks.
• Damit Webhooks für einen Feature-Service konfiguriert werden können, muss der Service Bearbeitungsfunktionen und aktivierte Änderungsverfolgung ohne Synchronisierung umfassen.
• Webhooks für einen Geoverarbeitungsservice können nur für asynchrone Services konfiguriert werden.

Hinweis:

In dieser Version sind Service-Webhooks Beta-Funktionen. Im Beta-Stadium sind diese Funktionen u. U. noch nicht vollständig und weisen bekannte Performance- oder Qualitätsprobleme auf. Diese werden nicht durch den technischen Support von Esri abgedeckt. Die Dokumentation zu Service-Webhook-APIs im Beta-Stadium finden Sie im PDF-Dokument Service webhooks administrator API guide . Weitere Informationen zu Beta-Funktionen in ArcGIS Enterprise finden Sie unter Beta-Funktionen.

Erstellen eines Organisations-Webhook

Organisations-Webhooks ermöglichen das Abonnieren von Triggern für Ereignisse, die mit ArcGIS Enterprise-Portalelementen, -Gruppen und -Benutzern verknüpft sind.

Hinweis:

Eine Beispiel-POST-Anforderung für die Erstellung eines Webhooks zu Benutzern, Gruppen und Elementen zugeordneten Ereignissen finden Sie unter Create Webhook in der REST-API-Dokumentation.

Führen Sie die folgenden Schritte aus, um einen Webhook für die Organisation zu erstellen:

1. Navigieren Sie zum ArcGIS-Portalverzeichnis, und melden Sie sich als ein Mitglied mit Administratorrolle an.

   Webhooks können nur von Administratoren oder Mitgliedern, denen die Standard-Administratorrolle zugewiesen wurde, erstellt und verwaltet werden.

   https://machine.domain.com/webadaptor/sharing/rest

   Nachdem Sie sich angemeldet haben, wird die Ressourcenseite User für Ihr Konto angezeigt.

2. Klicken Sie auf den Hyperlink Org ID, oder erstellen Sie eine Anforderung im folgenden Format, um zur Ressourcenseite Portal Self zu gelangen:
   https://machine.domain.com/webadaptor/sharing/rest/portals/self

3. Führen Sie einen Bildlauf zum Ende der Ressourcenseite Self durch, und klicken Sie auf Webhook > Create Webhook, um den Vorgang Create Webhook aufzurufen.
4. Geben Sie beim Endpunkt Create Webhook die folgenden Informationen an:
   1. Geben Sie einen eindeutigen Namen für den Webhook in das Textfeld Name ein.
   2. Geben Sie die Payload-URL für den Webhook-Empfänger im Textfeld Payload URL ein. Sie wird bei der Erstellung des Webhooks abgerufen, um sicherzustellen, dass eine erfolgreiche Verbindung zwischen dem Empfänger und dem ArcGIS Enterprise-Portal hergestellt werden kann.

      Im Folgenden finden Sie eine Beispiel-Payload-URL:

      https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow

   3. Legen Sie optional ein Secret für den Webhook fest, um Webhook-Nachrichten beim Empfänger zu authentifizieren. Geben Sie die benutzerdefinierte alphanumerische Zeichenfolge in das Textfeld Secret (Optional) ein.
   4. Geben Sie optional die Deaktivierungsinformationen für den Webhook in das Textfeld Configuration Properties ein.

      Der Webhook wird standardmäßig deaktiviert, wenn im Verlauf von fünf Tagen fünf Fehler aufgetreten sind.

   5. Wählen Sie unter Which events would you like to trigger this webhook entweder Let me define manually oder Send me everything aus.
      • Listen Sie bei Auswahl von Let me define manually die Trigger-Ereignisse, die für diesen Webhook verwendet werden, im Textfeld Send me changes for these comma separated events auf. Wenn Sie beispielsweise alle Ereignisse, die zu einer bestimmten Gruppe in der Organisation gehören, abonnieren möchten, geben Sie ein Trigger-Ereignis ähnlich dem unten gezeigten ein, wobei [groupID] die mit einer bestimmten Gruppe verknüpfte eindeutige ID darstellt:
        /groups/[groupID]/update

        Eine Liste aller unterstützten Ereignis-Trigger für Organisations-Webhooks finden Sie im Thema Ereignis-Trigger.
      • Bei Auswahl von Send me everything abonnieren Sie alle unterstützten Trigger-Ereignisse. Sie erhalten Benachrichtigungen für die einzelnen Ereignisse, sobald diese eintreten.
5. Klicken Sie nach dem Konfigurieren der obenstehenden Parameter auf Create Webhook, um die Anforderung zu senden.

   Nach Abschluss des Vorgangs wird der Organisation ein neuer Webhook hinzugefügt.

Konfigurieren von erweiterten Parametern für Organisations-Webhooks

Die erweiterten Einstellungen, die auf die Webhooks der Organisation angewendet werden, ermöglichen eine detailliertere Anpassung der Performance von Webhooks, z. B. durch das Angeben der Anzahl der Übermittlungsversuche, der Benachrichtigungszeit und der Zeit zwischen den Übermittlungsversuchen.

Hinweis:

Im Thema Update Webhook Settings in der REST-API-Dokumentation finden Sie ein Beispiel für eine POST-Anforderung, in der diese erweiterten Eigenschaften konfiguriert werden.

Gehen Sie wie folgt vor, um diese erweiterten Einstellungen festzulegen:

1. Navigieren Sie zum ArcGIS-Portalverzeichnis, und melden Sie sich als ein Mitglied mit Administratorrolle an. Webhooks können nur von Administratoren oder Mitgliedern, denen die Standard-Administratorrolle zugewiesen wurde, erstellt und verwaltet werden.
   https://machine.domain.com/webadaptor/sharing/rest

   Nachdem Sie sich angemeldet haben, wird die Ressourcenseite User für Ihr Konto angezeigt.

2. Klicken Sie auf den Hyperlink Org ID, oder erstellen Sie eine Anforderung im folgenden Format, um zur Ressourcenseite Portal Self zu gelangen:
   https://machine.domain.com/webadaptor/sharing/rest/portals/self

3. Führen Sie einen Bildlauf zum Ende der Ressourcenseite Self durch, und klicken Sie auf Webhook > Settings > Update, um den Vorgang Update Webhook aufzurufen.
4. Geben Sie auf dem Endpunkt Update Webhook Settings die folgenden Informationen an:
   1. Legen Sie einen Wert für Number of Notification Attempts fest.

      Dieser Wert gibt an, wie oft versucht wird, die Webhook-Payloads zu übermitteln. Standardmäßig unternimmt das ArcGIS Enterprise-Portal drei Versuche, die Payloads zu übermitteln. Der Wert für die Anzahl an Versuchen muss eine ganze Zahl zwischen 0 und 5 sein.

   2. Legen Sie einen Wert für Notification Time Out in Seconds fest.

      Dieser Wert gibt an, wie viele Sekunden vom ArcGIS Enterprise-Portal auf den Eingang einer Antwort von einem Empfänger gewartet wird. Standardmäßig wartet das ArcGIS Enterprise-Portal 10 Sekunden. Der Wert für die Anzahl an Sekunden, die vom ArcGIS Enterprise-Portal gewartet wird, muss eine ganze Zahl zwischen 0 und 60 Sekunden sein.

   3. Legen Sie einen Wert für Notification Elapsed Time in Seconds fest.

      Dieser Wert gibt an, wie viele Sekunden zwischen den einzelnen Übermittlungsversuchen für die Payload verstreichen. Standardmäßig versucht das ArcGIS Enterprise-Portal alle 5 Sekunden, eine weitere Payload zu übermitteln, wenn der vorherige Versuch nicht erfolgreich war, bis die unter Number of Notification Attempts angegebene Anzahl von Versuchen erreicht wurde.

5. Klicken Sie nach dem Konfigurieren der obenstehenden Parameter auf Update Webhook Settings, um die Anforderung zu senden.

   Nach Abschluss des Vorgangs werden die aktualisierten Eigenschaften für jeden konfigurierten Organisations-Webhook übernommen.

Erstellen eines Geoverarbeitungsservice-Webhook

Geoverarbeitungsservice-Webhooks ermöglichen das Abonnieren bestimmter Ereignis-Trigger, die mit den Geoverarbeitungsservices verknüpft sind.

Hinweis:

Ein Beispiel für eine POST-Anforderung, mit der ein Webhook für Geoverarbeitungsservices erstellt wird, finden Sie in der Webhook-REST-API-Beta-Dokumentation im PDF-Dokument Service webhooks administrator API guide .

Führen Sie die folgenden Schritte aus, um einen Webhook für einen Geoverarbeitungsservice zu erstellen:

1. Navigieren Sie zum ArcGIS Server-Administratorverzeichnis, und melden Sie sich als ein Mitglied mit entsprechenden Administratorberechtigungen an.
   Webhooks können nur von Administratoren, denen die Administratorberechtigungen "Aktualisieren", "Löschen", "Sicherheit und Infrastruktur" oder "Server" oder die Standard-Administratorrolle zugewiesen wurde, erstellt und verwaltet werden.
   https://machine.domain.com/webadaptor/admin

2. Navigieren Sie nach der Anmeldung zur Ressource Webhooks für einen Geoverarbeitungsservice, indem Sie auf Services > [ServiceName] > Webhooks > Create klicken, wobei [ServiceName] den Service darstellt, für den der Webhook erstellt wird. Klicken Sie bei Services, die sich in bestimmten Ordnern befinden, auf Services > [FolderName] > [ServiceName] > Webhooks > Create, wobei [FolderName] den Ordner, in dem sich der Service befindet, darstellt.

   Vorsicht:

   Webhooks für einen Geoverarbeitungsservice können nur für asynchrone Geoverarbeitungsservices konfiguriert werden.

3. Geben Sie auf dem Endpunkt Create Webhook die folgenden Informationen an:
   1. Geben Sie einen eindeutigen Namen für den Webhook in das Textfeld Name ein. Der Name darf nur alphanumerische Zeichen enthalten, da die Verwendung von Sonderzeichen zu einer Fehlermeldung führt.
   2. Legen Sie optional ein Secret für den Webhook fest, um Webhook-Nachrichten beim Empfänger zu authentifizieren. Geben Sie die benutzerdefinierte alphanumerische Zeichenfolge in das Textfeld Signature Key ein.
   3. Geben Sie die Payload-URL für den Webhook-Empfänger im Textfeld Hook URL ein. Sie wird bei der Erstellung des Webhooks abgerufen, um sicherzustellen, dass eine erfolgreiche Verbindung zwischen dem Empfänger und dem ArcGIS Server der Bereitstellung hergestellt werden kann. Im Folgenden finden Sie eine Beispiel-Payload:
      https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow

   4. Geben Sie optional den Medientyp an. Wählen Sie im Dropdown-Menü Content Type eine der folgenden Optionen aus:
      • application/json (Standardeinstellung)
      • application/x-www-form-urlencoded
   5. Definieren Sie optional das Format für die Payloads. Wählen Sie im Dropdown-Menü Payload Format eine der folgenden Optionen aus:
      • JSON (Standardeinstellung)
      • PJSON
   6. Optional können Sie mit dem Parameter Active Rückrufe aktivieren oder deaktivieren, wenn der Webhook ausgelöst wird. Wählen Sie zur Aktivierung True aus. Wählen Sie zur Deaktivierung False aus.

      Standardmäßig sind Rückrufe aktiviert.

4. Klicken Sie nach dem Konfigurieren der obenstehenden Parameter auf Create, um die Anforderung zu senden.

   Nach Abschluss des Vorgangs wird ein neuer Webhook für den spezifischen Geoverarbeitungsservice übernommen.

Hinweis:

Im Gegensatz zu Organisations- und Feature-Service-Webhooks verfügen Geoverarbeitungsservice-Webhooks über keine benutzerdefinierten Ereignis-Trigger. Geoverarbeitungsservice-Webhooks übermitteln Payloads, sobald ein Geoverarbeitungsauftrag abgeschlossen wurde. Weitere Informationen zu den für Geoverarbeitungsservices übermittelten Payloads finden Sie im Thema Payloads.

Erstellen eines Feature-Service-Webhook

Feature-Service-Webhooks ermöglichen das Abonnieren bestimmter Ereignis-Trigger, die mit Feature-Services verknüpft sind.

Hinweis:

Ein Beispiel für eine POST-Anforderung, mit der ein Webhook für Feature-Services erstellt wird, finden Sie in der Webhook-REST-API-Beta-Dokumentation im PDF-Dokument Service webhooks administrator API guide .

Zum Erstellen eines Webhook für einen Feature-Service führen Sie die folgenden Schritte aus:

1. Navigieren Sie zum ArcGIS Server-Administratorverzeichnis, und melden Sie sich als ein Mitglied mit entsprechenden Administratorberechtigungen an.

   Webhooks können nur von Administratoren, denen die Administratorberechtigungen "Aktualisieren", "Löschen", "Sicherheit und Infrastruktur" oder "Server" oder die Standard-Administratorrolle zugewiesen wurde, erstellt und verwaltet werden.

   https://machine.domain.com/webadaptor/admin

2. Navigieren Sie nach der Anmeldung zur Ressource Webhooks für einen Feature-Service, indem Sie auf Services > [ServiceName] > Webhooks > Create klicken, wobei [ServiceName] den Service darstellt, für den der Webhook erstellt wird. Klicken Sie bei Services, die sich in bestimmten Ordnern befinden, auf Services > [FolderName] > [ServiceName] > Webhooks > Create, wobei [FolderName] den Ordner, in dem sich der Service befindet, darstellt.

   Vorsicht:

   Damit Webhooks für einen Feature-Service konfiguriert werden können, muss der Feature-Service Bearbeitungsfunktionen und aktivierte Änderungsverfolgung ohne Synchronisierung umfassen.

3. Geben Sie auf dem Endpunkt Create Webhook die folgenden Informationen an:
   1. Geben Sie einen eindeutigen Namen für den Webhook in das Textfeld Name ein. Der Name darf nur alphanumerische Zeichen enthalten, da die Verwendung von Sonderzeichen zu einer Fehlermeldung führt.
   2. Listen Sie die für diesen Webhook verwendeten Ereignis-Trigger im Textfeld Change Type auf. Verwenden Sie beispielsweise den folgenden Ereignis-Trigger, um den Webhook bei jeder Erstellung eines Feature-Service aufzurufen:

      Beispiel

      FeaturesCreated

      Eine Liste aller unterstützten Ereignis-Trigger für Feature-Service-Webhooks finden Sie im Thema Ereignis-Trigger.
   3. Legen Sie optional ein Secret für den Webhook fest, um Webhook-Nachrichten beim Empfänger zu authentifizieren. Geben Sie die benutzerdefinierte alphanumerische Zeichenfolge in das Textfeld Signature Key ein.
   4. Geben Sie die Payload-URL für den Webhook-Empfänger im Textfeld Hook URL ein. Sie wird bei der Erstellung des Webhooks abgerufen, um sicherzustellen, dass eine erfolgreiche Verbindung zwischen dem Empfänger und dem ArcGIS Server der Bereitstellung hergestellt werden kann. Im Folgenden finden Sie eine Beispiel-Payload:
      https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow

   5. Geben Sie optional den Medientyp an. Wählen Sie im Dropdown-Menü Content Type eine der folgenden Optionen aus:
      • application/json (Standardeinstellung)
      • application/x-www-form-urlencoded
   6. Definieren Sie optional das Format für die Payloads. Wählen Sie im Dropdown-Menü Payload Format eine der folgenden Optionen aus:
      • JSON (Standardeinstellung)
      • PJSON
   7. Optional können Sie mit dem Parameter Active Rückrufe aktivieren oder deaktivieren, wenn der Webhook ausgelöst wird. Wählen Sie zur Aktivierung True aus. Wählen Sie zur Deaktivierung False aus.

      Standardmäßig sind Rückrufe aktiviert.

   8. Passen Sie die Planung für Webhooks an, indem Sie die Information Seconds im Textfeld Schedule bearbeiten. Senken Sie den Wert Seconds bei Feature-Services mit vielen regelmäßig vorgenommenen Änderungen, um häufiger Webhooks zu empfangen, die dafür weniger Ereignisinformationen in der Payload enthalten. Heben Sie den Wert der Eigenschaft Seconds bei Feature-Services, die keinen regelmäßigen Änderungen unterliegen, an, um seltener Webhooks zu empfangen, die mehr Ereignisinformationen in der Payload enthalten.

      Der Mindest- und Standardwert für die Planung liegt bei 20 Sekunden.

4. Klicken Sie nach dem Konfigurieren der obenstehenden Parameter auf Create, um die Anforderung zu senden.

   Nach Abschluss des Vorgangs wird ein neuer Webhook auf den spezifischen Feature-Service angewendet.