Nach dem Auslösen eines Webhooks wird eine Payload an die angegebene Payload-URL übermittelt. Jedes Ereignis für einen bestimmten Webhook-Typ folgt einem ähnlichen JSON-Schema, das Informationen enthält, die für das unterstützte Ereignis relevant sind. In den nachfolgenden Abschnitten werden die in den Payloads enthaltenen Eigenschaften definiert; außerdem werden in ihnen Beispiel-Payloads für Organisations- und Service-Webhooks bereitgestellt.
Payloads für Organisations-Webhooks
In der folgenden Tabelle sind die in den Payloads für Organisations-Webhooks enthaltenen Eigenschaften aufgeführt, die Informationen über Änderungen und Updates an Benutzern, Gruppen, Elementen und Rollen in der Organisation zurückgeben.
Eigenschaft | Beschreibung |
---|---|
webhookName | Der Name des Webhooks, von dem die Payload übermittelt wurde |
webhookId | Die ID des Webhooks, von dem die Payload übermittelt wurde |
portalURL | Die URL des Portals, bei dem der Webhook registriert ist |
when | Der Zeitpunkt, zu dem die Payload übermittelt wurde |
username | Der Benutzer, der das Ereignis ausgelöst hat |
userId | Die ID des Benutzers, der das Ereignis ausgelöst hat |
when | Der Zeitpunkt, zu dem das Ereignis eingetreten ist |
operation | Der vom Benutzer ausgeführte Vorgangstyp In der folgenden Liste sind die Vorgangstyp-Eigenschaft, die in der Payload zurückgegeben wird, und die mit ihr verknüpften Portalverzeichnis-API-Vorgänge dargestellt:
|
source | Der Elementtyp, für den der Vorgang ausgeführt wurde. Hierbei kann es sich um items, group oder user handeln. |
id | Die ID des Quellelements, für das der Vorgang ausgeführt wurde. |
properties | Die weiteren mit spezifischen Ereignis-Triggern verknüpften Eigenschaften. In der folgenden Liste sind die zusätzlichen in der Payload enthaltenen Eigenschaften dargestellt. Weitere Informationen dazu, welche Ereignis-Trigger zusätzliche Eigenschaften enthalten, finden Sie im Thema Ereignis-Trigger, oder klicken Sie unten auf die Eigenschaften, um mehr über einen spezifischen Trigger und seine Eigenschaften zu erfahren. |
Payload-Beispiel
Im folgenden Beispiel ist eine Beispiel-Payload für einen Organisations-Webhook abgebildet, der ausgelöst wird, nachdem eine spezifische Gruppe aktualisiert wurde:
{
"info": {
"webhookName": "Group monitoring",
"webhookId": "72fed926aeb74c9ca8a22aacddc6725a",
"portalURL": "https://orgURL/portal/",
"when": 1543192196521
},
"events": [
{
"username": "administrator",
"userId": "173dd04b69134bdf99c5000aad0b6298",
"when": 1543192196521,
"operation": "update",
"source": "group",
"id": "173dd04b69134bdf99c5000aad0b6298",
"properties": {}
}
]
}
Payloads für Geoverarbeitungsservice-Webhooks
In der folgenden Tabelle sind die in den Payloads für Geoverarbeitungsservice-Webhooks enthaltenen Eigenschaften aufgeführt, die Informationen über Änderungen an den Geoverarbeitungsservices zurückgeben.
Eigenschaft | Beschreibung |
---|---|
serviceType | Der Servicetyp, für den der Webhook konfiguriert wurde. Bei Feature-Service-Webhooks gibt diese Eigenschaft nur GPServer zurück. |
jobId | Die ID des Geoverarbeitungsservice-Auftrags. |
statusURL | Die URL des Status des Geoverarbeitungsservice-Auftrags, über die die Statusinformationen des Auftrags abgerufen werden können. |
name | Der Name des Webhooks. |
taskName | Der Name des Geoverarbeitungswerkzeugs. |
folderName | Der Ordner, in dem sich der Geoverarbeitungsservice befindet. |
serviceName | Der Name des Geoverarbeitungsservice. |
eventType | Die Eigenschaft, aus der hervorgeht, wie der Geoverarbeitungsservice-Auftrag abgeschlossen wurde. Die Geoverarbeitungsservice-Webhooks abonnieren keine spezifischen Ereignis-Trigger. Diese Webhooks übermitteln vielmehr ihre Payloads, wenn ein Geoverarbeitungsservice-Auftrag abgeschlossen wurde. In diesen Payloads wird angegeben, ob der Auftrag erfolgreich abgeschlossen wurde (esriJobSucceeded), ob er erfolglos abgeschlossen wurde (esriJobFailed), oder ob er abgebrochen wurde (esriJobCancelled). Wert: esriJobSucceeded | esriJobFailed | esriJobCancelled |
when | Der Zeitstempel (formatiert als Millisekunden seit der Epoche) der Zeit, als der Auftrag abgeschlossen wurde. |
Payload-Beispiel
Im folgenden Beispiel ist eine Beispiel-Payload für einen Geoverarbeitungsservice-Webhook abgebildet, der ausgelöst wird, wenn ein Geoverarbeitungsservice-Auftrag abgeschlossen wurde.
{
"serviceType": "GPServer",
"jobId": "jeccad3d9099d4e1591859fdb08f4d1eb",
"statusURL": https://machine.domain.com/webadaptor/rest/services/my_Service/GPServer/jobs/jeccad3d9099d4e1591859fdb08f4d1eb?f=pjson,
"name": "webhook1",
"taskName": "",
"folderName": "",
"serviceName": "my_Service",
"events": [
{
"eventType": "esriJobSucceeded",
"when": 1652458959318
}
]
}
Payloads für Feature-Service-Webhooks
In der folgenden Tabelle sind die in den Payloads für Feature-Service-Webhooks enthaltenen Eigenschaften aufgeführt, die Informationen über Änderungen an den Feature-Services zurückgeben.
Eigenschaft | Beschreibung |
---|---|
serviceType | Der Servicetyp, für den der Webhook konfiguriert wurde. Bei Feature-Service-Webhooks gibt diese Eigenschaft nur FeatureServer zurück. |
changesUrl | Die URL zum Endpunkt Änderungen extrahieren für den Service. Während nur der Ereignis-Trigger und der Zeitpunkt des Auftretens in die Payload einbezogen werden, können Sie diese URL aufrufen, um mehr über die jeweiligen Änderungen zu erfahren, die während des Ereignisses erfolgt sind. |
id | Die ID des Webhooks, von dem die Payload übermittelt wurde |
folderName | Der Ordner, in dem sich der Feature-Service befindet. |
serviceName | Der Name des Feature-Service. |
eventType | Der an dem Feature-Service durchgeführte Ereignistyp. Weitere Informationen zu den Änderungstypwerten, die Sie beim Konfigurieren Ihres Webhooks abonnieren können, finden Sie im Thema Ereignis-Trigger. Werte: * | FeaturesCreated | FeaturesUpdated | FeaturesDeleted | FeaturesEdited | AttachmentsCreated | AttachmentsUpdated | AttachmentsDeleted | LayerSchemaChanged | LayerDefinitionChanged | FeatureServiceDefinitionChanged | FeaturesPosted |
when | Der Zeitstempel (formatiert als Millisekunden seit der Epoche) des Zeitpunkts, zu dem das Ereignis eingetreten ist. |
Payload-Beispiel
Im folgenden Beispiel ist eine Beispiel-Payload für einen Feature-Service-Webhook abgebildet, der ausgelöst wird, wenn ein Feature-Service aktualisiert (FeaturesUpdated), gelöscht (FeaturesDeleted) oder bearbeitet (FeaturesEdited) wird.
{
"serviceType": "FeatureServer",
"changesUrl": "https://machine.domain.com/webadaptor/rest/services/Hosted/my_Service/FeatureServer/extractChanges?serverGens=12942,13026",
"id": "84e17696-c9d8-43cc-9cf7-5aeb658db12b",
"folderName": "Hosted",
"serviceName": "my_Service",
"events": [
{
"eventType": "FeaturesUpdated",
"when": 1652459863334
},
{
"eventType": "FeaturesDeleted",
"when": 1652459863334
},
{
"eventType": "FeaturesEdited",
"when": 1652459863334
}
]
}