Une fois qu’un webhook est déclenché, une charge utile est livrée à l’URL de charge utile spécifiée. Chaque événement d’un type de webhook spécifique suit une structure JSON similaire, contenant des informations associées à l’événement pris en charge. Les sections ci-dessous définissent les propriétés incluses dans les charges utiles et fournissent des exemples de charge utile pour les webhooks d’organisation et de service.
Charges utiles des webhooks d’organisation
La table suivante répertorie les propriétés incluses dans les charges utiles des webhooks de l’organisation, en renvoyant des informations sur les changements et mises à jour des utilisateurs, groupes, éléments et rôles de l’organisation.
| Propriété | Description |
|---|---|
| webhookName | Nom du webhook qui a livré la payload. |
| webhookId | ID du webhook qui a livré la payload. |
| portalURL | URL du portail auprès duquel le webhook est inscrit. |
| when | Heure de livraison de la payload. |
| username | Utilisateur qui a déclenché l’événement. |
| userId | ID de l’utilisateur qui a déclenché l’événement. |
| when | Heure de l’événement. |
| operation | Type d’opération réalisé par l’utilisateur. La liste ci-dessous met en évidence la propriété du type d’opération renvoyée dans la charge utile, ainsi que leurs opérations d’API de répertoire du portail associées :
|
| source | Type d’élément sur lequel l’opération a été réalisée. Il peut s’agir de items, de group ou de user. |
| id | ID de l’élément source sur lequel l’opération a été réalisée. |
| properties | Propriétés supplémentaires associées à des déclencheurs d’événements spécifiques. La liste suivante met en évidence les propriétés supplémentaires incluses dans la charge utile. Pour savoir quels déclencheurs d’événements incluent des propriétés supplémentaires, consultez Déclencheurs d’événements. Vous pouvez également cliquer sur les propriétés ci-dessous pour en savoir plus sur un déclencheur en particulier et sur ses propriétés. |
Payload d’exemple
L’exemple suivant illustre un échantillon de charge utile pour un webhook d’organisation qui se déclenche lorsqu’un groupe donné a été mis à jour :
{
"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": {}
}
]
}
Charges utiles des webhooks de service de géotraitement
La table suivante répertorie les propriétés incluses dans les charges utiles des webhooks de service de géotraitement, en renvoyant des informations sur les changements apportés aux services de géotraitement.
| Propriété | Description |
|---|---|
| serviceType | Type de service pour lequel le webhook a été configuré. Pour les webhooks de service d’entités, cette propriété renvoie uniquement GPServer. |
| jobId | ID de la tâche du service de géotraitement. |
| statusURL | URL de statut de la tâche du service de géotraitement pouvant être interrogée pour renvoyer les informations sur le statut de la tâche. |
| name | Nom du webhook. |
| taskName | Nom de l’outil de géotraitement. |
| folderName | Dossier contenant le service de géotraitement. |
| serviceName | Nom du service de géotraitement. |
| eventType | Propriété représentant la façon dont la tâche du service de géotraitement s’est exécutée. Les webhooks de service de géotraitement ne sont pas abonnés à des déclencheurs d’événements spécifiques. En revanche, ces webhooks livrent leurs charges utiles une fois qu’une tâche du service de géotraitement est exécutée. Ces charges utiles indiquent si la tâche s’est exécutée correctement (esriJobSucceeded), incorrectement (esriJobFailed) ou si elle a été annulée (esriJobCancelled). Valeurs : esriJobSucceeded | esriJobFailed | esriJobCancelled |
| when | Horodatage (en millisecondes depuis l’époque) de la date d’exécution de la tâche. |
Payload d’exemple
L’exemple suivant illustre un échantillon de charge utile pour un webhook de service de géotraitement qui se déclenche lorsqu’une tâche de service de géotraitement est exécutée.
{
"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
}
]
}
Charges utiles des webhooks de service d’entités
La table suivante répertorie les propriétés incluses dans les charges utiles des webhooks de service d’entités, en renvoyant des informations sur les changements apportés aux services d’entités.
| Propriété | Description |
|---|---|
| serviceType | Type de service pour lequel le webhook a été configuré. Pour les webhooks de service d’entités, cette propriété renvoie uniquement FeatureServer. |
| changesUrl | URL vers le point de terminaison Extraire les modifications du service. Même si seuls le déclencheur de l’événement et l’heure d’occurrence sont inclus dans la charge utile, vous pouvez accéder à cette URL pour en savoir plus sur les changements spécifiques qui sont survenus au cours de l’événement. |
| id | ID du webhook qui a livré la payload. |
| folderName | Dossier contenant le service d’entités. |
| serviceName | Nom du service d’entités. |
| eventType | Type d’événement effectué sur le service d’entités. Pour en savoir plus sur les valeurs des types de changement auxquels vous pouvez vous abonner lorsque vous configurez le webhook, reportez-vous à la rubrique Déclencheurs d’événements. Valeurs : * | FeaturesCreated | FeaturesUpdated | FeaturesDeleted | FeaturesEdited | AttachmentsCreated | AttachmentsUpdated | AttachmentsDeleted | LayerSchemaChanged | LayerDefinitionChanged | FeatureServiceDefinitionChanged |
| when | Horodatage (en millisecondes depuis l’époque) de la date de survenue de l’événement. |
Payload d’exemple
L’exemple suivant illustre un échantillon de charge utile pour un webhook de service d’entités qui se déclenche lorsqu’un service d’entités est actualisé (FeaturesUpdated), supprimé (FeaturesDeleted) et mis à jour (FeaturesEdited) :
{
"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
}
]
}
Vous avez un commentaire à formuler concernant cette rubrique ?