Ein Webhook ist eine Methode, mit der eine Webanwendung oder ein Web-Service Informationen nahezu in Echtzeit an einen anderen Web-Service senden kann. Die Kommunikation wird durch ein bestimmtes Ereignis oder bestimmte Ereignisse ausgelöst, die Sie definieren. Anstatt wiederholt nach Aktualisierungen zu suchen, sendet das System eine Benachrichtigung, sobald das auslösende Ereignis eintritt.
In ArcGIS Online können Webhooks für gehostete Feature-Layer, Sichten gehosteter Feature-Layer und gehostete Tabellen erstellt werden. Diese Webhooks senden Payloads basierend auf definierten Ereignis-Triggern an einen Webhook-Empfänger. Der Empfänger ist so konfiguriert, dass er automatisierte Aktionen ausführt, z. B. eine vordefinierte Liste von Empfängern über die Änderungen benachrichtigt, die Informationen zu den Änderungen in eine externe App exportiert, um einen Bericht der Änderungen zu erstellen, oder Skripte zur Qualitätskontrolle für die bearbeiteten Daten ausführt.
Nachfolgend sind die Komponenten dieses Kommunikationskanals aufgeführt:
- Ereignis-Trigger: Jeder Ereignis-Trigger gibt die API-Vorgänge an, die auf dem Quellen-Feature-Service des Elements ausgeführt werden und den Webhook aufrufen. Wenn ein Benutzer einen Vorgang ausführt, der als Ereignis-Trigger festgelegt wurde, übermittelt der Webhook diese Informationen (als Payload) an den Webhook-Empfänger. Sie legen die Trigger beim Erstellen eines Webhooks fest. Informationen zu den spezifischen Ereignis-Triggern, die Sie festlegen können, finden Sie unter Feature-Layer-Ereignis-Trigger.
- Payload: Die Payload enthält die für das auslösende Ereignis relevanten Informationen. Informationen zum Inhalt einer Payload finden Sie unter Payloads für Feature-Layer-Webhooks.
- Webhook-Empfänger: Der Webhook-Empfänger akzeptiert die Payload und sendet Informationen an eine vordefinierte Liste von Empfängern (Benutzer oder Apps). Beispielsweise kann er eine E-Mail oder eine Textnachricht senden, um den Benutzer über das auslösende Ereignis zu informieren, die Informationen über das auslösende Ereignis zur Archivierung an eine externe Datenbank senden oder ein Skript für die Daten ausführen, das auf dem auslösenden Ereignis basiert.
Sie können Web-Service-Empfänger von Drittanbietern oder benutzerdefinierte Web-Services für Webhook-Empfänger verwenden. Sie müssen Webhook-Empfänger so konfigurieren, dass sie über eine HTTPS-Verbindung kommunizieren, um Payloads empfangen zu können, und Ihre ArcGIS Online-Organisation muss auf die Empfänger zugreifen können, bevor Sie einen Webhook zu einem Element hinzufügen können. Der Zugriff auf den Webhook-Empfänger erfolgt über die Payload-URL, die Sie beim Erstellen des Webhooks angeben.
Der Webhook-Empfänger wird außerhalb von ArcGIS Online konfiguriert. Nach der Konfiguration des Empfängers können Sie einen Webhook erstellen.
Anforderungen
Bevor Sie einen Webhook für einen gehosteten Feature-Layer, eine Sicht oder eine Tabelle erstellen können, muss das Element die folgenden Anforderungen erfüllen:
- Die Einstellung Änderungen an den Daten verfolgen (hinzugefügte, aktualisierte und gelöschte Features) muss aktiviert sein.
- Das Element darf sich nicht im Papierkorb befinden.
Jedes Element kann über bis zu 10 Webhooks verfügen.
Webhook-Erstellung
Die Typen von Organisationsmitgliedern, die Webhooks für gehostete Feature-Layer, Sichten gehosteter Feature-Layer und gehostete Tabellen erstellen und verwalten können, sind in der folgenden Tabelle zusammen mit Informationen darüber aufgeführt, wo sie Webhooks verwalten können.
Typ des Organisationsmitglieds | Wo Webhooks verwaltet werden können |
---|---|
Mitglieder der Standardadministratorrolle oder Mitglieder einer benutzerdefinierten Rolle, die über Administratorberechtigungen zum Erstellen und Verwalten von Webhooks verfügen. |
|
Besitzer des Elements |
|
Mitglieder einer Gruppe mit gemeinsamer Aktualisierung, für die das Element freigegeben wurde | Die Registerkarte Einstellungen der Elementseite eines gehosteten Feature-Layers, einer Sicht oder einer Tabelle: Das Gruppenmitglied kann Webhooks für das jeweilige Element erstellen und verwalten. |
Befolgen Sie die für Ihre Rolle in der Organisation zutreffenden Anweisungen, um einen Webhook zu erstellen:
- Organisationsadministrator
- Besitzer des Elements oder Mitglied einer Gruppe mit gemeinsamer Aktualisierung, für die das Element freigegeben wurde