Wenn Sie einen Webhook erstellen, können Sie bestimmte, mit API-Vorgängen verknüpfte Ereignis-Trigger abonnieren, durch die der Webhook ausgelöst wird und die die Informationen zu dem Ereignis in der Payload bereitstellen. In den nachfolgenden Abschnitten sind die verfügbaren Ereignis-Trigger und die mit ihnen verknüpften URIs oder Typänderungswerte für Organisations- und Feature-Services-Webhooks aufgeführt.
Hinweis:
Anders als Organisations- und Feature-Service-Webhooks haben Geoverarbeitungsservice-Webhooks keine benutzerdefinierten Ereignis-Trigger. Geoverarbeitungsservice-Webhooks übermitteln Payloads, sobald ein Geoverarbeitungsauftrag abgeschlossen wurde. Weitere Informationen zu den für Geoverarbeitungsservices bereitgestellten Payloads finden Sie im Thema Payloads.
Ereignisse der Organisationselemente
In der folgenden Tabelle sind die Ereignis-Trigger für die Elemente Ihrer Organisation aufgeführt; dazu zählen Webkarten, Web-Apps, Layer, Pakete und PDFs:
| Ereignis-Trigger | URI |
|---|---|
Alle Trigger-Ereignisse für sämtliche Elemente | /items |
Ein Element wird dem Portal hinzugefügt | /items/add |
Ein Element wird gelöscht | /items/delete |
Ein Element wird aktualisiert | /items/update |
Ein Element wird verschoben oder der Besitzer ändert sich | /items/move |
Ein Element wird veröffentlicht | /items/publish |
Ein Element wird freigegeben | /items/share |
Die Freigabe eines Elements wird aufgehoben | /items/unshare |
Der Besitz eines Elements wird neu zugewiesen | /items/reassign |
Ein Kommentar wird jedem Element hinzugefügt | /items/addComment |
Ein Kommentar wird aus jedem Element gelöscht | /items/deleteComment |
Ein Kommentar wird in jedem Element aktualisiert | /items/updateComment |
Alle Trigger-Ereignisse für ein bestimmtes Element | /items/<itemID> |
Ein bestimmtes Element wird gelöscht | /items/<itemID>/delete |
Die Eigenschaften eines bestimmten Elements werden aktualisiert Hinweis:Die Elementeigenschaften, die aktualisiert werden können, variieren je nach Elementtyp, und der Update-Vorgang wird von eindeutigen Aktionen ausgelöst. Wenn das Element z. B. eine Webkarte ist, sind das Aktualisieren des Tags, das Konfigurieren eines Pop-up und das Ändern der Grundkarte Aktualisierungsereignisse, die den Webhook auslösen. | /items/<itemID>/update |
Der Besitzer eines bestimmten Elements ändert sich oder das Element wird verschoben | /items/<itemID>/move |
Ein bestimmtes Element wird veröffentlicht | /items/<itemID>/publish |
Ein bestimmtes Element wird freigegeben | /items/<itemID>/share |
Die Freigabe eines bestimmten Elements wird aufgehoben | /items/<itemID>/unshare |
Der Besitz eines bestimmten Elements wird neu zugewiesen | /items/<itemID>/reassign |
Ein Kommentar wird einem bestimmten Element hinzugefügt | /items/<itemId>/addComment |
Ein Kommentar wird aus einem bestimmten Element gelöscht | /items/<itemId>/deleteComment |
Ein Kommentar wird in einem bestimmten Element aktualisiert | /items/<itemId>/updateComment |
Eigenschaften eines Element-Ereignis-Triggers
Einige Ereignis-Trigger für Organisationselemente geben zusätzliche Eigenschaften in ihren Payloads zurück. In den nachfolgenden Abschnitten werden die zusätzlichen Payload-Eigenschaften dieser Trigger beschrieben.
Ein bestimmtes Element wird freigegeben
In der Payload von Webhooks, die den /items/<itemID>/share-Ereignis-Trigger abonnieren, ist die sharedToGroups-Eigenschaft enthalten. Mit der Eigenschaft sharedToGroups wird angegeben, wie ein Element freigegeben wurde. Wenn das Element für eine Gruppe freigegeben wurde, enthält das JSON-Objekt properties die ID jeder Gruppe, für die das Element freigegeben wurde. Wenn das Element für die Organisation insgesamt freigegeben wurde, enthält das Objekt Organization. Wenn das Element für die Öffentlichkeit freigegeben wurde, enthält das Objekt Everyone. Im folgenden Beispiel ist die Freigabe eines Elements für bestimmte Gruppen sowie sowohl für die Öffentlichkeit als auch für bestimmte Gruppen dargestellt.
Beispiele
//groupIDs
"properties": {
"sharedToGroups": [
"ecd6646698b24180904e4888d5eaede3",
"2dff15c514ad4f04b291e304e24a524b"
]
}
//Everyone and groupIDs
"properties": {
"sharedToGroups": [
"Everyone",
"4adc30bb03054812a846fa592de105de",
"a4e6e37e2f7d4bb5b64d587c91d39a2c"
]
}
Der Besitz eines Elements wird neu zugewiesen
In der Payload von Webhooks, die den /items/reassign-Ereignis-Trigger abonnieren, ist die reassignedTo-Eigenschaft enthalten. Mit der reassignedTo-Eigenschaft wird der neue Benutzer angegeben, dem ein Element oder eine Gruppe erneut zugewiesen wird, und es wird der Benutzername des neuen Besitzers im JSON-Objekt properties zurückgegeben.
Beispiel
"properties": {
"reassignedTo": ["newOwner"]
}
Die Freigabe eines bestimmten Elements wird aufgehoben
In der Payload von Webhooks, die den /items/<itemID>/unshare-Ereignis-Trigger abonnieren, ist die unsharedFromGroups-Eigenschaft enthalten. Mit der unsharedFromGroups-Eigenschaft wird angegeben, wie die Freigabe eines Element aufgehoben wurde. Wenn die Freigabe eines Elements für eine Gruppe aufgehoben wurde, enthält das JSON-Objekt properties die IDs jeder Gruppe, für die die Freigabe des Elements aufgehoben wurde. Wenn die Freigabe des Elements für die Organisation insgesamt aufgehoben wurde, enthält das Objekt Organization. Wenn die Freigabe des Elements für die Öffentlichkeit aufgehoben wurde, enthält das Objekt Everyone. Die folgenden Beispieleigenschaften zeigen die Aufhebung der Freigabe eines Elements für die Öffentlichkeit sowie die Aufhebung der Freigabe eines Elements für eine bestimmte Gruppe.
Beispiele
//Everyone
"properties": {
"unsharedFromGroups": ["Everyone"]
}
//groupID
"properties": {
"unsharedFromGroups": [
"4adc30bb03054812a846fa592de105de"
]
}
Der Besitz eines bestimmten Elements wird neu zugewiesen.
In der Payload von Webhooks, die den /items/<itemID>/reassign-Ereignis-Trigger abonnieren, ist die reassignedTo-Eigenschaft enthalten. Mit der reassignedTo-Eigenschaft wird der neue Benutzer angegeben, dem ein Element oder eine Gruppe zugewiesen wird, und es wird der Benutzername des neuen Besitzers im JSON-Objekt properties zurückgegeben.
Beispiel
"properties": {
"reassignedTo": ["newOwner"]
}
Ereignisse der Organisationsgruppen
In der folgenden Tabelle sind die Ereignis-Trigger für die Gruppen Ihrer Organisation aufgeführt.
| Ereignis-Trigger | URI |
|---|---|
Alle Trigger-Ereignisse für sämtliche Gruppen | /groups |
Eine Gruppe wird hinzugefügt | /groups/add |
Eine Gruppe wird aktualisiert | /groups/update |
Eine Gruppe wird gelöscht | /groups/delete |
Löschschutz wird für eine Gruppe aktiviert | /groups/protect |
Löschschutz wird für eine Gruppe deaktiviert | /groups/unprotect |
Ein Benutzer wird in eine Gruppe eingeladen | /groups/invite |
Ein Benutzer wird einer Gruppe hinzugefügt | /groups/addUsers |
Ein Benutzer wird aus einer Gruppe entfernt | /groups/removeUsers |
Die Rolle eines Benutzers in einer Gruppe wird aktualisiert | /groups/updateUsers |
Der Besitz einer Gruppe wird neu zugewiesen | /groups/reassign |
Ein Element wird für eine beliebige Gruppe freigegeben | /groups/itemShare |
Die Freigabe eines Elements für eine beliebige Gruppe wurde aufgehoben | /groups/itemUnshare |
Ein Benutzer beantragt den Beitritt zu einer Gruppe | /groups/requestJoin |
Alle Trigger-Ereignisse für eine bestimmte Gruppe | /groups/<groupID> |
Eine bestimmte Gruppe wird aktualisiert Hinweis:Alle allgemeinen Änderungen, die an den Gruppeneinstellungen vorgenommen werden, stellen eine Aktualisierung dar. Beispielsweise wird durch das Ändern des Zugriffs einer Gruppe ein Aktualisierungsereignis ausgelöst. | /groups/<groupID>/update |
Eine bestimmte Gruppe wird gelöscht | /groups/<groupID>/delete |
Löschschutz wird für eine bestimmte Gruppe aktiviert | /groups/<groupID>/protect |
Löschschutz wird für eine bestimmte Gruppe deaktiviert | /groups/<groupID>/unprotect |
Ein Benutzer wird in eine bestimmte Gruppe eingeladen | /groups/<groupID>/invite |
Ein Benutzer wird einer bestimmten Gruppe hinzugefügt | /groups/<groupID>/addUsers |
Ein Benutzer wird aus einer bestimmten Gruppe entfernt | /groups/<groupID>/removeUsers |
Die Rolle eines Benutzers in einer bestimmten Gruppe wird aktualisiert. | /groups/<groupID>/updateUsers |
Der Besitz einer bestimmten Gruppe wird neu zugewiesen | /groups/<groupID>/reassign |
Für eine Gruppe wurde ein Element freigegeben | /groups/<groupID>/itemShare |
Die Freigabe eines Elements für eine Gruppe wurde aufgehoben | /groups/<groupID>/itemUnshare |
Ein Benutzer beantragt den Beitritt zu einer bestimmten Gruppe | /groups/<groupId>/requestJoin |
Eigenschaften eines Gruppen-Ereignis-Triggers
Einige Ereignis-Trigger für Organisationsgruppen geben zusätzliche Eigenschaften in der Payload zurück. In den nachfolgenden Abschnitten werden die zusätzlichen Payload-Eigenschaften dieser Trigger beschrieben.
Ein Benutzer wird in eine bestimmte Gruppe eingeladen
In der Payload von Webhooks, die den /groups/<groupID>/invite-Ereignis-Trigger abonnieren, ist die invitedUserNames-Eigenschaft enthalten. Mit der invitedUserNames-Eigenschaft werden die Benutzernamen der in eine Gruppe eingeladenen Benutzer angegeben, und es wird eine Liste mit Benutzernamen im JSON-Objekt properties zurückgegeben.
Beispiel
"properties": {
"invitedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Ein Benutzer wird einer bestimmten Gruppe hinzugefügt
In der Payload von Webhooks, die den /groups/<groupID>/addUsers-Ereignis-Trigger abonnieren, ist die addedUserNames-Eigenschaft enthalten. Mit der addedUserNames-Eigenschaft werden die Benutzernamen der einer Gruppe hinzugefügten Benutzer angegeben, und es wird eine Liste mit Benutzernamen im JSON-Objekt properties zurückgegeben.
Beispiel
"properties": {
"addedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Ein Benutzer wird aus einer bestimmten Gruppe entfernt
In der Payload von Webhooks, die /groups/<groupID>/removeUsers abonnieren, ist die removeUserNames-Eigenschaft enthalten. Mit der removeUserNames-Eigenschaft wird der Benutzername der aus einer Gruppe entfernten Benutzer angegeben, und es wird eine Liste mit Benutzernamen im JSON-Objekt properties zurückgegeben.
Beispiel
"properties": {
"removedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Die Rolle eines Benutzers in einer bestimmten Gruppe wird aktualisiert.
In der Payload von Webhooks, die /groups/<groupID>/updateUsers abonnieren, ist die updateUserNames-Eigenschaft enthalten. Mit der updateUserNames-Eigenschaft wird der Benutzername der Benutzer angegeben, deren Gruppenrollen aktualisiert wurden, und es wird eine Liste mit Benutzernamen im JSON-Objekt properties zurückgegeben.
Beispiel
"properties": {
"updatedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Für eine Gruppe wurde ein Element freigegeben
In der Payload von Webhooks, die /groups/<groupID>/itemShare abonnieren, ist die sharedItems-Eigenschaft enthalten. Mit der sharedItems-Eigenschaft werden die itemID und der Elementtyp des für eine Gruppe freigegebenen Elements angegeben, und diese Information wird im JSON-Objekt properties zurückgegeben.
Beispiel
"properties": {
"sharedItems": [
{
"itemId": "6cd80cb32d4a4b4d858a020e57fba7b1",
"itemType": "Map Package"
}
]
}
Die Freigabe eines Elements für eine Gruppe wurde aufgehoben
In der Payload von Webhooks, die /groups/<groupID>/itemUnshare abonnieren, ist die unsharedItems-Eigenschaft enthalten. Mit der unsharedItems-Eigenschaft werden die itemID und der Elementtyp des Elements angegeben, dessen Freigabe für eine Gruppe aufgehoben wurde, und diese Information wird im JSON-Objekt properties zurückgegeben.
Beispiel
"properties": {
"unsharedItems": [
{
"itemId": "7dd95fadaec84859ab8ed1059e675e0c",
"itemType": "Image"
}
]
}
Ereignisse der Organisationsbenutzer
In der folgenden Tabelle sind die Ereignis-Trigger für die Benutzer Ihrer Organisation aufgeführt.
| Ereignis-Trigger | URI |
|---|---|
Alle Trigger-Ereignisse für sämtliche Benutzer im Portal | /users |
Ein Benutzer wird der Organisation hinzugefügt | /users/add |
Ein Benutzer hat sich beim Portal angemeldet. | /users/signin |
Ein Benutzer hat sich beim Portal abgemeldet | /users/signout |
Ein Benutzer wird gelöscht | /users/delete |
Ein Benutzerprofil wird aktualisiert Hinweis:Bei jeder Änderung am Profil des Benutzers wird ein Aktualisierungsereignis ausgelöst. Änderungen an der Rolle, am Benutzertyp oder der Lizenz eines Benutzers gelten jedoch nicht als Aktualisierung des Benutzerprofils. | /users/update |
Ein Benutzerkonto wird deaktiviert | /users/disable |
Ein Benutzerkonto wird aktiviert | /users/enable |
Einem Benutzer wird eine neue Rolle zugewiesen | /users/updateUserRole |
Einem Benutzer wird ein neuer Benutzertyp zugewiesen | /users/updateUserLicenseType |
Eine Liste von Benutzerkonten wird aktiviert | /users/bulkEnable |
Eine Liste von Benutzerkonten wird deaktiviert | /users/bulkDisable |
Alle Trigger-Ereignisse, die mit einem bestimmten Benutzer verknüpft sind | /users/<username> |
Ein bestimmter Benutzer hat sich beim Portal angemeldet | /users/<username>/signIn |
Ein bestimmter Benutzer ist beim Portal abgemeldet | /users/<username>/signOut |
Ein bestimmter Benutzer wird gelöscht | /users/<username>/delete |
Ein bestimmtes Benutzerprofil wird aktualisiert Hinweis:Bei jeder Änderung am Profil des Benutzers wird ein Aktualisierungsereignis ausgelöst. Änderungen an der Rolle, am Benutzertyp oder der Lizenz eines Benutzers gelten jedoch nicht als Aktualisierung des Benutzerprofils. | /users/<username>/update |
Ein bestimmtes Benutzerkonto wird deaktiviert | /users/<username>/disable |
Ein bestimmtes Benutzerkonto wird aktiviert | /users/<username>/enable |
Einem bestimmten Benutzer wird eine neue Rolle zugewiesen | /users/<username>/updateUserRole |
Einem bestimmten Benutzer wird ein neuer Benutzertyp zugewiesen | /users/<username>/updateUserLicenseType |
Eigenschaften eines Benutzer-Ereignis-Triggers
Einige Ereignis-Trigger für Organisationsbenutzer geben zusätzliche Eigenschaften in der Payload zurück. In den nachfolgenden Abschnitten werden die zusätzlichen Payload-Eigenschaften dieser Trigger beschrieben.
Einem bestimmten Benutzer wird eine neue Rolle zugewiesen
In der Payload von Webhooks, die /users/<username>/updateUserRole abonnieren, ist die userRoleUpdatedTo-Eigenschaft enthalten. Mit der userRoleUpdatedTo-Eigenschaft wird die neue Rolle angegeben, die dem Benutzer zugewiesen wird, und die neue Rolle wird im JSON-Objekt properties zurückgegeben.
"properties": {
"userRoleUpdatedTo": ["New role"]
}
Einem bestimmten Benutzer wird ein neuer Benutzertyp zugewiesen
In der Payload von Webhooks, die /users/<username>/updateUserLicenseType abonnieren, ist die userLicenseTypeUpdatedTo-Eigenschaft enthalten. Mit der userLicenseTypeUpdatedTo-Eigenschaft wird der neue Benutzertyp angegeben, dem ein Benutzer zugewiesen wird, und der neue Benutzertyp wird im JSON-Objekt properties zurückgegeben.
"properties": {
"userLicenseTypeUpdatedTo": ["Editor"]
}
Ereignisse der Organisationsrollen
In der folgenden Tabelle sind die Ereignis-Trigger für die Benutzerrollen Ihrer Organisation aufgeführt.
| Ereignis-Trigger | URI |
|---|---|
Alle Trigger-Ereignisse für sämtliche Rollen im Portal | /roles |
Eine neue Rolle wird erstellt | /roles/add |
Eine vorhandene Rolle wird aktualisiert Hinweis:Bei jeder Änderung an den Rollen in Ihrer Organisation wird ein Aktualisierungsereignis ausgelöst. | /roles/update |
Eine vorhandene Rolle wird gelöscht | /roles/delete |
Eigenschaften eines Rollen-Ereignis-Triggers
Einige Ereignis-Trigger für Organisationsrollen geben zusätzliche Eigenschaften in der Payload zurück. Im nachfolgenden Abschnitt werden die zusätzlichen Payload-Eigenschaften dieser Trigger beschrieben.
Eine neue Rolle wird erstellt
In der Payload von Webhooks, die den /roles/add-Ereignis-Trigger abonnieren, ist die name-Eigenschaft enthalten. Mit der name-Eigenschaft wird der Name der Rolle angegeben, die erstellt wurde, und der Name der Rolle wird im JSON-Objekt properties zurückgegeben.
Beispiel
"properties": {
"name": ["New role"]
}
Ereignisse der Feature-Services
In der folgenden Tabelle sind die Ereignis-Trigger für Feature-Service-Webhooks aufgeführt.
| Ereignis-Trigger | Wert |
|---|---|
Jedes Ereignis wird ausgelöst | * |
Ein neues Feature wird erstellt | FeaturesCreated |
Ein Feature wird aktualisiert | FeaturesUpdated |
Ein Feature wird gelöscht | FeaturesDeleted |
Ein Feature wird bearbeitet (z. B. Einfügung, Aktualisierung oder Löschung) | FeaturesEdited |
Einem Feature wird eine neue Anlage hinzugefügt | AttachmentsCreated |
Eine Feature-Anlage wird aktualisiert | AttachmentsUpdated |
Eine Feature-Anlage wird gelöscht | AttachmentsDeleted |
Das Schema eines Feature-Layers wird geändert | LayerSchemaChanged |
Die Definition eines Feature-Layers wird geändert | LayerDefinitionChanged |
Die Definition eines Feature-Service wird geändert | FeatureServiceDefinitionChanged |
Der Zurückschreibevorgang wird für den Feature-Service durchgeführt. Hinweis:Um einen Webhook mit diesem Ereignis-Trigger zu planen, muss für den Feature-Service die Funktion "Versionsverwaltung" aktiviert sein. Weitere Informationen finden Sie in der Dokumentation Erstellen von Webhooks. | FeaturesPosted |