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.
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:
Organisations-Webhooks können über die ArcGIS Enterprise-Portal-Website oder das ArcGIS Portal Directory erstellt werden. 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.
Erstellen eines Organisations-Webhook im ArcGIS Portal Directory
Führen Sie die folgenden Schritte aus, um einen Organisations-Webhook über das ArcGIS Portal Directory zu erstellen:
- Navigieren Sie zum ArcGIS Portal Directory, und melden Sie sich als ein Mitglied mit Administratorrolle an.
Organisations-Webhooks können nur von Administratoren mit der Berechtigung "Organisations-Webhooks" oder von 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.
- 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
- Führen Sie einen Bildlauf zum Ende der Ressourcenseite Self durch, und klicken Sie auf Webhook > Create Webhook, um den Vorgang Create Webhook aufzurufen.
- Geben Sie beim Endpunkt Create Webhook die folgenden Informationen an:
- Geben Sie einen eindeutigen Namen für den Webhook in das Textfeld Name ein.
- 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
- 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.
- 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.
- 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:
Eine Liste aller unterstützten Ereignis-Trigger für Organisations-Webhooks finden Sie unter Ereignis-Trigger./groups/[groupID]/update
- Bei Auswahl von Send me everything abonnieren Sie alle unterstützten Trigger-Ereignisse. Sie erhalten Benachrichtigungen für die einzelnen Ereignisse, sobald diese eintreten.
- 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:
- 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.
Erstellen eines Organisations-Webhook auf der ArcGIS Enterprise-Portal-Website
Führen Sie die folgenden Schritte aus, um einen Organisations-Webhook über dieArcGIS Enterprise-Portal-Website zu erstellen:
- Vergewissern Sie sich, dass Sie als Standardadministrator oder als Mitglied mit einer benutzerdefinierten Rolle mit der Berechtigung "Organisations-Webhooks" angemeldet sind.
- Navigieren Sie zu Organisation > Einstellungen > Webhooks.
- Klicken Sie auf Webhook erstellen.
- Führen Sie im Fenster Webhook erstellen die folgenden Schritte aus:
- Geben Sie einen eindeutigen Namen für den Webhook in das Textfeld Name ein.
- 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 Trigger-Ereignisse Sie abonnieren möchten.
- 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.
- Wählen Sie ein Trigger-Ereignis aus dem Dropdown-Menü Events aus. Wenn beispielsweise der Webhook aufgerufen werden soll, sobald ein bestimmtes Element veröffentlicht wird, wählen Sie /items/<Element-ID>/publish aus.
- 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.
- 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:
- Legen Sie im Textfeld Secret (optional) optional einen Secret-Wert für den Webhook fest. Der Secret-Wert wird in die Webhook-Payload einbezogen und zur Authentifizierung von Webhook-Nachrichten beim Empfänger verwendet.
- 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.
Hinweis:
Die erweiterten Eigenschaften der Organisations-Webhooks können über die ArcGIS Enterprise-Portal-Website oder das ArcGIS Portal Directory geändert werden. 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.
Konfigurieren erweiterter Parameter im ArcGIS Portal Directory
Gehen Sie wie folgt vor, um diese erweiterten Einstellungen über das ArcGIS Portal Directory festzulegen:
- Navigieren Sie zum ArcGIS Portal Directory, und melden Sie sich als ein Mitglied mit Administratorrolle an.
Organisations-Webhooks können nur von Mitgliedern mit der Standard-Administratorrolle oder mit der Berechtigung "Organisations-Webhooks" 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.
- 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
- Führen Sie einen Bildlauf zum Ende der Ressourcenseite Self durch, und klicken Sie auf Webhook > Settings > Update, um den Vorgang Update Webhook aufzurufen.
- Geben Sie auf dem Endpunkt Update Webhook Settings die folgenden Informationen an:
- 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.
- 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 das ArcGIS Enterprise-Portal abwartet, muss eine ganze Zahl zwischen 0 und 60 Sekunden sein.
- 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.
- Legen Sie einen Wert für Number of Notification Attempts fest.
- 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.
Konfigurieren erweiterter Parameter auf der ArcGIS Enterprise-Portal-Website
Gehen Sie wie folgt vor, um diese erweiterten Einstellungen über die ArcGIS Enterprise-Portal-Website festzulegen:
- Melden Sie sich als Standardadministrator oder als Mitglied mit einer benutzerdefinierten Rolle mit der Berechtigung "Organisations-Webhooks" an.
- Klicken Sie im oberen Bereich der Seite auf Organisation und dann auf die Registerkarte Einstellungen.
- Klicken Sie links auf der Seite auf Webhooks.
- Klicken Sie auf Erweiterte Webhook-Einstellungen.
- Führen Sie im Fenster Erweiterte Webhook-Einstellungen die folgenden Schritte aus:
- 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.
- 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.
- 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.
- Legen Sie einen Wert für Number of delivery attempts fest.
- Klicken Sie nach dem Konfigurieren der obenstehenden Einstellungen auf Save.
Die aktualisierten Eigenschaften werden 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:
Geoverarbeitungsservice-Webhooks können nur über das ArcGIS Server-Administratorverzeichnis erstellt werden. Eine Beispiel-POST-Anforderung für das Erstellen eines Geoverarbeitungsservice-Webhooks finden Sie unter Create webhook in der REST-API-Dokumentation.
Führen Sie die folgenden Schritte aus, um einen Webhook für einen Geoverarbeitungsservice zu erstellen:
- Navigieren Sie zum ArcGIS Server-Administratorverzeichnis, und melden Sie sich als ein Mitglied mit entsprechenden Berechtigungen an.Webhooks können nur von Mitgliedern mit der Berechtigung "Geoverarbeitung" oder der Standard-Administratorrolle erstellt und verwaltet werden.
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.
https://machine.domain.com/webadaptor/admin
- 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.
- Geben Sie auf dem Endpunkt Create Webhook die folgenden Informationen an:
- 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.
- 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.
Service-Webhooks nutzen die Überprüfung der Signatur, um die Integrität und Sicherheit von Webhook-Payloads sicherzustellen, die von ArcGIS Enterprise an einen Webhook-Empfänger gesendet werden. Die in das Textfeld Signature Key eingegebene alphanumerische Zeichenfolge wird als geheimer Schlüssel behandelt, der ArcGIS Enterprise und dem Webhook-Empfänger bekannt ist und unabhängig von beiden gespeichert wird. Wenn ein Webhook-Ereignis ausgelöst wird, werden der geheime Schlüssel und die Payload mit einem HMAC-SHA256-Algorithmus gehasht, sodass die Signatur erstellt wird. Die Signatur wird dann in der Webhook-Anforderung als x-esriHook-Signature-Header-Wert übergeben. Wenn die Webhook-Payload an den Empfänger übermittelt wird, verwendet der Empfänger den geheimen Schlüssel und die Payload, um mit dem gleichen HMAC-SHA256-Algorithmus, der auch von ArcGIS Enterprise verwendet wurde, eine eigene Signatur zu erstellen. Wenn die Signatur im Anforderungs-Header mit dem vom Webhook-Empfänger neu berechneten Wert übereinstimmt, kann der Empfänger der Webhook-Payload vertrauen. Andernfalls könnte der Empfänger die eingehende Webhook-Payload ablehnen.
- 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
- 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
- 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
- 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.
- 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 unter Payloads.Erstellen eines Feature-Service-Webhook
Feature-Service-Webhooks ermöglichen das Abonnieren bestimmter Ereignis-Trigger, die mit Feature-Services verknüpft sind.
Hinweis:
Feature-Service-Webhooks können nur über das ArcGIS Server-Administratorverzeichnis erstellt werden. Eine Beispiel-POST-Anforderung für das Erstellen eines Feature-Service-Webhooks finden Sie unter Create webhook in der REST-API-Dokumentation.
Zum Erstellen eines Webhook für einen Feature-Service führen Sie die folgenden Schritte aus:
- Navigieren Sie zum ArcGIS Server-Administratorverzeichnis, und melden Sie sich als ein Mitglied mit entsprechenden Berechtigungen an.Webhooks können nur von Mitgliedern mit der Berechtigung "Feature-Layer" oder der Standard-Administratorrolle erstellt und verwaltet werden.
https://machine.domain.com/webadaptor/admin
- 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.
- Geben Sie auf dem Endpunkt Create Webhook die folgenden Informationen an:
- 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.
- 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:
Eine Liste aller unterstützten Ereignis-Trigger für Feature-Service-Webhooks finden Sie unter Ereignis-Trigger.Beispiel
FeaturesCreated
- 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.
Service-Webhooks nutzen die Überprüfung der Signatur, um die Integrität und Sicherheit von Webhook-Payloads sicherzustellen, die von ArcGIS Enterprise an einen Webhook-Empfänger gesendet werden. Die in das Textfeld Signature Key eingegebene alphanumerische Zeichenfolge wird als geheimer Schlüssel behandelt, der ArcGIS Enterprise und dem Webhook-Empfänger bekannt ist und unabhängig von beiden gespeichert wird. Wenn ein Webhook-Ereignis ausgelöst wird, werden der geheime Schlüssel und die Payload mit einem HMAC-SHA256-Algorithmus gehasht, sodass die Signatur erstellt wird. Die Signatur wird dann in der Webhook-Anforderung als x-esriHook-Signature-Header-Wert übergeben. Wenn die Webhook-Payload an den Empfänger übermittelt wird, verwendet der Empfänger den geheimen Schlüssel und die Payload, um mit dem gleichen HMAC-SHA256-Algorithmus, der auch von ArcGIS Enterprise verwendet wurde, eine eigene Signatur zu erstellen. Wenn die Signatur im Anforderungs-Header mit dem vom Webhook-Empfänger neu berechneten Wert übereinstimmt, kann der Empfänger der Webhook-Payload vertrauen. Andernfalls könnte der Empfänger die eingehende Webhook-Payload ablehnen.
- 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
- 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
- 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
- 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.
- 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.
- 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.