Skip To Content

Erstellen von Webhooks

ArcGIS 11.4 (Windows)  | |  Hilfearchiv

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.
  • Zum Erstellen und Verwalten von Organisations-Webhooks müssen Sie entweder über die Berechtigung "Organisation-Webhooks" oder über die Standard-Administratorrolle verfügen.
  • Zum Erstellen und Verwalten von Geoverarbeitungsservice-Webhooks müssen Sie entweder über die Berechtigung "Geoverarbeitung" oder über die Standard-Administratorrolle verfügen.
    Hinweis:

    Benutzer, denen die Berechtigung "Geoverarbeitung" zugewiesen wurde, müssen außerdem über die Berechtigung zum Veröffentlichen serverbasierter Layer verfügen, die zu ihrer benutzerdefinierten Rolle hinzugefügt wird.

  • Zum Erstellen und Verwalten von Feature-Service-Webhooks müssen Sie entweder über die Berechtigung "Feature-Layer" oder über die Standard-Administratorrolle verfügen.
  • 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 gehosteten Feature-Service konfiguriert werden können, muss der Service Bearbeitungsfunktionen und aktivierte Änderungsverfolgung ohne Synchronisierung umfassen.
  • Wenn Webhooks für einen nicht gehosteten Feature-Service konfiguriert werden sollen, müssen die vom Service referenzierten Enterprise-Geodatabase-Daten die Anforderungen für die Änderungsverfolgung erfüllen und einem der folgenden Muster entsprechen:
    • Es handelt sich um einen nichtversionierten Feature-Service mit aktivierter Archivierung und Global-IDs.
    • Es handelt sich um einen nach Verzweigung versionierten Feature-Service, für den die Funktion "Versionsverwaltung" nicht aktiviert ist und bei dem Änderungen direkt auf die Features der Default-Version angewendet werden.
    • Es handelt sich um einen nach Verzweigung versionierten Feature-Service mit aktivierter Funktion "Versionsverwaltung". Wenn die Funktion "Versionsverwaltung" aktiviert ist, kann der Service einen Webhook mit dem Ereignis-Trigger FeaturesPosted erstellen, der den Webhook immer dann aufruft, wenn die Operation Zurückschreiben für den Service ausgeführt wird.
    Hinweis:

    Die Unterstützung für nach Verzweigung versionierte Feature-Services wurde in ArcGIS Enterprise 11.3 hinzugefügt.

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

Konfigurieren von Organisations-Webhooks

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

Erstellen eines Organisations-Webhook

Führen Sie die folgenden Schritte aus, um einen Organisations-Webhook über dieArcGIS Enterprise-Portal-Website zu erstellen:

  1. Vergewissern Sie sich, dass Sie als Standardadministrator oder als Mitglied mit einer benutzerdefinierten Rolle mit der Berechtigung "Organisations-Webhooks" angemeldet sind.
  2. Navigieren Sie zu Organisation > Einstellungen > Webhooks.
  3. Klicken Sie unter Organisations-Webhooks auf Webhook erstellen.
  4. Führen Sie im Fenster Webhook erstellen die folgenden Schritte aus:
    1. Geben Sie einen eindeutigen Namen für den Webhook in das Textfeld Name ein.
    2. Wählen Sie einen Webhook-Typ aus dem Dropdown-Menü Typ aus.
      • Wenn Sie Alle auswählen, werden alle unterstützten Ereignis-Trigger abonniert. Sie erhalten Benachrichtigungen für die einzelnen Ereignisse, sobald diese eintreten.
      • Wenn Sie Elemente, Benutzer, Gruppen oder Rollen auswählen, können Sie manuell festlegen, welche Ereignis-Trigger Sie abonnieren möchten.
    3. Wenn Sie einen anderen Webhook-Typ als Alle auswählen, wird ein zusätzliches Dropdown-Menü angezeigt, das sich auf den ausgewählten Webhook-Typ bezieht. Wenn Sie beispielsweise Elemente als Webhook-Typ ausgewählt haben, wird das Dropdown-Menü Elemente angezeigt, über das Sie ein bestimmtes Element für die Überwachung durch den Webhook auswählen können.
    4. Wählen Sie Ereignis-Trigger aus dem Dropdown-Menü Ereignisse aus. Wenn beispielsweise der Webhook aufgerufen werden soll, sobald ein bestimmtes Element veröffentlicht wird, wählen Sie /items/<Element-ID>/publish aus.
    5. Wählen Sie einen Webhook-Empfänger-Typ aus.
      • Geben Sie bei Auswahl von Webhook-URL die Payload-URL für den Webhook-Empfänger an. 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
      • Wählen Sie bei Verwendung von Notebook das Notebook aus, das beim Auslösen des Webhooks ausgeführt werden soll.
        Hinweis:

        Wenn die Option Notebook nicht verfügbar ist, wurde für das Portal keine Notebook Server-Instanz konfiguriert. Wenn die Option verfügbar ist, jedoch nicht ausgewählt werden kann, verfügen Sie über keine Notebooks, für die Webhooks konfiguriert werden können. Sie müssen der Besitzer des Notebook-Elements sein, das für den Webhook verwendet werden soll.

    6. Legen Sie im Textfeld Secret (optional) optional einen Secret-Wert für den Webhook fest. Der Secret-Wert wird zum Generieren einer in den Webhook-Payload-Headern enthaltenen Signatur verwendet. Anhand dieser Signatur kann der Webhook-Empfänger feststellen, ob die Nachricht vertrauenswürdig ist.
  5. Klicken Sie auf Webhook erstellen.

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.

Gehen Sie wie folgt vor, um diese erweiterten Einstellungen über die ArcGIS Enterprise-Portal-Website festzulegen:

  1. Melden Sie sich als Standardadministrator oder als Mitglied mit einer benutzerdefinierten Rolle mit der Berechtigung "Organisations-Webhooks" an.
  2. Navigieren Sie zu Organisation > Einstellungen > Webhooks.
  3. Klicken Sie unter Organisations-Webhooks auf Erweiterte Webhook-Einstellungen.
  4. Führen Sie im Fenster Erweiterte Webhook-Einstellungen die folgenden Schritte aus:
    1. Legen Sie einen Wert für Number of delivery 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 timeout 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 das ArcGIS Enterprise-Portal abwartet, muss eine ganze Zahl zwischen 0 und 60 Sekunden sein.

    3. Legen Sie einen Wert für Notification elapsed time 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 Anzahl der Übermittlungsversuche angegebene Anzahl von Versuchen erreicht wurde.

  5. Klicken Sie nach dem Konfigurieren der obenstehenden Einstellungen auf Save.

    Die aktualisierten Eigenschaften werden für jeden konfigurierten Organisations-Webhook übernommen.

Konfigurieren von Service-Webhooks

Service-Webhooks ermöglichen das Abonnieren von Triggern für Ereignisse, die mit den Feature-Services Ihrer Organisation verknüpft sind, oder nach Abschluss von Aufträgen für Geoverarbeitungsservices.

Erstellen eines Service-Webhooks

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

  1. Melden Sie sich als Standardadministrator oder als Mitglied einer benutzerdefinierten Rolle mit Administratorberechtigungen zum Erstellen und Verwalten von Service-Webhooks bei Ihrer Organisation an.

    Hinweis:
    Mitglieder, denen die Publisher-Rolle zugewiesen wurde, können keine Service-Webhooks über die ArcGIS Enterprise-Portal-Site erstellen oder verwalten und müssen diese Workflows über die administrative API ausführen.

  2. Navigieren Sie zu Organisation > Einstellungen > Webhooks.
  3. Klicken Sie unter Service-Webhooks auf Webhook erstellen.
  4. Führen Sie im Fenster Webhook erstellen die folgenden Schritte aus:
    1. Geben Sie einen eindeutigen Namen für den Webhook in das Textfeld Name ein.
    2. Wählen Sie im Dropdown-Menü Service einen Service aus.

      Hinweis:

      Durch Auswählen eines Geoverarbeitungsservice wird das Ereignis als Service ist beendet festgelegt. Durch Auswählen eines Feature-Service wird das Dropdown-Menü Ereignisse aktiviert.

    3. Wählen Sie bei Auswahl eines Feature-Service-Webhooks einen Ereignis-Trigger aus dem Dropdown-Menü Ereignisse aus. Wenn beispielsweise der Webhook aufgerufen werden soll, sobald eine Bearbeitung eine neue Anlage umfasst, wählen Sie AttachmentsCreated aus.
    4. Geben Sie die Payload-URL für den Webhook-Empfänger in das Textfeld Webhook-URL ein. 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
    5. Legen Sie im Textfeld Secret (optional) optional einen Secret-Wert für den Webhook fest. Der Secret-Wert wird zum Generieren einer in den Webhook-Payload-Headern enthaltenen Signatur verwendet. Anhand dieser Signatur kann der Webhook-Empfänger die feststellen, ob die Nachricht vertrauenswürdig ist.
  5. Klicken Sie auf Webhook erstellen.

Konfigurieren von erweiterten Parametern für Service-Webhooks

Die erweiterten Einstellungen, die auf die Service-Webhooks 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.

Gehen Sie wie folgt vor, um diese erweiterten Einstellungen über die ArcGIS Enterprise-Portal-Website festzulegen:

  1. Melden Sie sich als Standardadministrator oder als Mitglied einer benutzerdefinierten Rolle mit Administratorberechtigungen zum Erstellen und Verwalten von Service-Webhooks bei Ihrer Organisation an.

    Hinweis:
    Mitglieder, denen die Publisher-Rolle zugewiesen wurde, können keine Service-Webhooks über die ArcGIS Enterprise-Portal-Site erstellen oder verwalten und müssen diese Workflows über die administrative API ausführen.

  2. Navigieren Sie zu Organisation > Einstellungen > Webhooks.
  3. Klicken Sie unter Service-Webhooks auf Erweiterte Webhook-Einstellungen.
  4. Führen Sie im Fenster Erweiterte Webhook-Einstellungen die folgenden Schritte aus:
    1. Legen Sie einen Wert für Number of delivery attempts fest.

      Dieser Wert gibt an, wie oft versucht wird, die Webhook-Payloads zu übermitteln. Standardmäßig unternimmt das System 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 timeout fest.

      Dieser Wert gibt an, wie viele Sekunden vom System auf den Eingang einer Antwort von einem Empfänger gewartet wird. Standardmäßig wartet das System 10 Sekunden. Der Wert muss ein ganze Zahl zwischen 0 und 60 Sekunden sein.

    3. Legen Sie einen Wert für Notification elapsed time fest.

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

    4. Legen Sie einen Wert für Anzahl vergangener Tage fest.

      Dieser Wert gibt die Anzahl der Tage an, an denen eine bestimmte Anzahl von Fehlern auftreten kann, bevor der Webhook deaktiviert wird. Standardmäßig akzeptiert das System eine bestimmte Anzahl von Fehlern (angegeben in Maximale Fehlerzahl) über einen Zeitraum von 5 Tagen. Dieser Wert muss eine ganze Zahl zwischen 1 und 30 sein.

    5. Legen Sie einen Wert für Maximale Fehlerzahl fest.

      Dieser Wert gibt die Anzahl der Fehler an, die an einer bestimmte Anzahl von Tagen auftreten können, bevor der Webhook deaktiviert wird. Standardmäßig akzeptiert das System 5 Fehler über eine Anzahl von Tagen (angegeben in Anzahl vergangener Tage), bevor der Webhook deaktiviert wird. Dieser Wert muss eine ganze Zahl zwischen 1 und 30 sein.

  5. Klicken Sie nach dem Konfigurieren der obenstehenden Einstellungen auf Save.

    Die aktualisierten Eigenschaften werden für jeden konfigurierten Service-Webhook übernommen.