Lorsque vous créez un webhook, vous pouvez vous abonner à des déclencheurs d’événements spécifiques liés à des opérations d’API qui invoqueront le webhook et livreront les informations de l’événement via la charge utile. Les sections ci-dessous répertorient les déclencheurs d’événements disponibles et leurs URI associés ou les valeurs des types de changement pour les webhooks d’organisation et de service d’entités.
Remarque :
Contrairement aux webhooks d’organisation et de service d’entités, les webhooks de service de géotraitement n’ont pas de déclencheurs d’événements définis par l’utilisateur. Les webhooks de service de géotraitement livrent les charges utiles une fois qu’une tâche de géotraitement est exécutée. Pour en savoir plus sur les charges utiles livrées pour les services de géotraitement, reportez-vous à la rubrique Charges utiles.
Événements des éléments de l’organisation
La table suivante répertorie les déclencheurs d’événements pour les éléments de l’organisation, dont notamment les cartes Web, les applications Web, les couches, les paquetages et les fichiers PDF :
| Déclencheur d’événement | URI |
|---|---|
Tous les événements déclencheurs pour tous les éléments | /items |
Un élément est ajouté au portail | /items/add |
N’importe quel élément est supprimé | /items/delete |
N’importe quel élément est mis à jour | /items/update |
N’importe quel élément est déplacé ou son appartenance modifiée | /items/move |
N’importe quel élément est publié | /items/publish |
N’importe quel élément est partagé | /items/share |
Le partage de n’importe quel élément est annulé | /items/unshare |
La propriété d’un élément est réaffectée | /items/reassign |
Un commentaire a été ajouté à un élément | /items/addComment |
Un commentaire a été supprimé d’un élément | /items/deleteComment |
Un commentaire a été mis à jour pour un élément | /items/updateComment |
Tous les événements déclencheurs pour un élément en particulier | /items/<itemID> |
Un élément en particulier est supprimé | /items/<itemID>/delete |
Les propriétés d’un élément en particulier sont mises à jour Remarque :Les propriétés d’élément pouvant être mises à jour varient selon les types d’élément et des actions uniques déclenchent l’opération Update. Par exemple, si l’élément est une carte Web, la mise à jour de la balise, la configuration d’une fenêtre contextuelle ou le changement de fond de carte sont tous des événements de mise à jour qui déclenchent le webhook. | /items/<itemID>/update |
La propriété d’un élément en particulier est modifié ou l’élément est déplacé | /items/<itemID>/move |
Un élément en particulier est publié | /items/<itemID>/publish |
Un élément en particulier est partagé | /items/<itemID>/share |
Le partage d’un élément en particulier est annulé | /items/<itemID>/unshare |
La propriété d’un élément en particulier est réaffectée | /items/<itemID>/reassign |
Un commentaire a été ajouté à un élément spécifique | /items/<itemId>/addComment |
Un commentaire a été supprimé d’un élément spécifique | /items/<itemId>/deleteComment |
Un commentaire a été mis à jour pour un élément spécifique | /items/<itemId>/updateComment |
Propriétés des déclencheurs d’événements des éléments
Certains des déclencheurs d’événements pour les éléments de l’organisation renvoient des propriétés supplémentaires dans leurs charges utiles. Les sections ci-dessous décrivent les propriétés supplémentaires des charges utiles pour ces déclencheurs.
Un élément en particulier est partagé
Les webhooks qui s’abonnent au déclencheur d’événement /items/<itemID>/share ont la propriété sharedToGroups incluse dans leur charge utile. La propriété sharedToGroups indique la manière dont un élément a été partagé. Si l’élément a été partagé avec un groupe, l’objet JSON properties inclut l’ID de chaque groupe avec lequel l’élément a été partagé. Si l’élément a été partagé avec l’organisation dans son ensemble, l’objet inclut Organization. Si l’élément a été partagé publiquement, l’objet inclut Everyone. L’exemple ci-dessous illustre le partage d’un élément avec certains groupes, ainsi que le partage d’un élément à la fois publiquement et avec certains groupes.
Exemples
//groupIDs
"properties": {
"sharedToGroups": [
"ecd6646698b24180904e4888d5eaede3",
"2dff15c514ad4f04b291e304e24a524b"
]
}
//Everyone and groupIDs
"properties": {
"sharedToGroups": [
"Everyone",
"4adc30bb03054812a846fa592de105de",
"a4e6e37e2f7d4bb5b64d587c91d39a2c"
]
}
La propriété d’un élément est réaffectée
Les webhooks qui s’abonnent au déclencheur d’événement /items/reassign ont la propriété reassignedTo incluse dans leur charge utile. La propriété reassignedTo indique le nouvel utilisateur auquel un élément ou groupe est réaffecté, en renvoyant le nom d’utilisateur du nouveau propriétaire dans l’objet JSON properties.
Exemple
"properties": {
"reassignedTo": ["newOwner"]
}
Le partage d’un élément en particulier est annulé
Les webhooks qui s’abonnent au déclencheur d’événement /items/<itemID>/unshare ont la propriété unsharedFromGroups incluse dans leur charge utile. La propriété unsharedFromGroups indique la manière dont le partage d’un élément a été annulé. Si le partage de l’élément avec un groupe a été annulé, l’objet JSON properties inclut les ID de chaque groupe avec lequel l’élément n’est plus partagé. Si le partage de l’élément avec l’organisation dans son ensemble a été annulé, l’objet inclut Organization. Si le partage de l’élément avec le public a été annulé, l’objet inclut Everyone. Les propriétés d’exemple ci-dessous illustrent l’annulation du partage d’un élément avec le public, ainsi que l’annulation du partage d’un élément avec un groupe spécifique.
Exemples
//Everyone
"properties": {
"unsharedFromGroups": ["Everyone"]
}
//groupID
"properties": {
"unsharedFromGroups": [
"4adc30bb03054812a846fa592de105de"
]
}
La propriété d’un élément en particulier est réaffectée
Les webhooks qui s’abonnent au déclencheur d’événement /items/<itemID>/reassign ont la propriété reassignedTo incluse dans leur charge utile. La propriété reassignedTo indique le nouvel utilisateur auquel un élément ou groupe est affecté, en renvoyant le nom d’utilisateur du nouveau propriétaire dans l’objet JSON properties.
Exemple
"properties": {
"reassignedTo": ["newOwner"]
}
Événements des groupes de l’organisation
La table suivante répertorie les déclencheurs d’événements pour les groupes de l’organisation :
| Déclencheur d’événement | URI |
|---|---|
Tous les événements déclencheurs pour tous les groupes | /groups |
Un groupe est ajouté | /groups/add |
N’importe quel groupe est mis à jour | /groups/update |
N’importe quel groupe est supprimé | /groups/delete |
Le paramètre Delete Protection (Protection contre la suppression) est activé pour un groupe | /groups/protect |
Le paramètre Delete Protection (Protection contre la suppression) est désactivé pour un groupe | /groups/unprotect |
Un utilisateur est invité dans un groupe | /groups/invite |
Un utilisateur est ajouté à un groupe | /groups/addUsers |
Un utilisateur est supprimé d’un groupe | /groups/removeUsers |
Le rôle d’un utilisateur est mis à jour dans un groupe | /groups/updateUsers |
La propriété d’un groupe est réaffectée | /groups/reassign |
Un élément est partagé avec un groupe | /groups/itemShare |
Le partage d’un élément avec un groupe est annulé | /groups/itemUnshare |
Un utilisateur demande à rejoindre un groupe | /groups/requestJoin |
Tous les événements déclencheurs pour un groupe en particulier | /groups/<groupID> |
Un groupe en particulier est mis à jour Remarque :Toute modification générale apportée aux paramètres de groupe constitue une mise à jour. Par exemple, le changement d’accès d’un groupe déclenche un événement de mise à jour. | /groups/<groupID>/update |
Un groupe en particulier est supprimé | /groups/<groupID>/delete |
Le paramètre Delete Protection (Protection contre la suppression) est activé pour un groupe en particulier | /groups/<groupID>/protect |
Le paramètre Delete Protection (Protection contre la suppression) est désactivé pour un groupe en particulier | /groups/<groupID>/unprotect |
Un utilisateur est invité dans un groupe en particulier | /groups/<groupID>/invite |
Un utilisateur est ajouté à un groupe en particulier | /groups/<groupID>/addUsers |
Un utilisateur est supprimé d’un groupe en particulier | /groups/<groupID>/removeUsers |
Le rôle d’un utilisateur est mis à jour dans un groupe en particulier | /groups/<groupID>/updateUsers |
La propriété d’un groupe en particulier est réaffectée | /groups/<groupID>/reassign |
Un élément est partagé avec un groupe | /groups/<groupID>/itemShare |
Le partage d’un élément avec un groupe donné est annulé | /groups/<groupID>/itemUnshare |
Un utilisateur demande à rejoindre un groupe spécifique | /groups/<groupId>/requestJoin |
Propriétés des déclencheurs d’événements des groupes
Certains des déclencheurs d’événements pour les groupes de l’organisation renvoient des propriétés supplémentaires dans la charge utile. Les sections ci-dessous décrivent les propriétés supplémentaires des charges utiles pour ces déclencheurs.
Un utilisateur est invité dans un groupe en particulier
Les webhooks qui s’abonnent au déclencheur d’événement /groups/<groupID>/invite ont la propriété invitedUserNames incluse dans leur charge utile. La propriété invitedUserNames indique les noms des utilisateurs invités à rejoindre un groupe, en renvoyant une liste de noms d’utilisateurs dans l’objet JSON properties.
Exemple
"properties": {
"invitedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Un utilisateur est ajouté à un groupe en particulier
Les webhooks qui s’abonnent au déclencheur d’événement /groups/<groupID>/addUsers ont la propriété addedUserNames incluse dans leur charge utile. La propriété addedUserNames indique les noms des utilisateurs qui ont été ajoutés à un groupe, en renvoyant une liste de noms d’utilisateurs dans l’objet JSON properties.
Exemple
"properties": {
"addedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Un utilisateur est supprimé d’un groupe en particulier
Les webhooks qui s’abonnent à /groups/<groupID>/removeUsers ont la propriété removeUserNames incluse dans leur charge utile. La propriété removeUserNames indique les noms des utilisateurs retirés d’un groupe, en renvoyant une liste de noms d’utilisateurs dans l’objet JSON properties.
Exemple
"properties": {
"removedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Le rôle d’un utilisateur est mis à jour dans un groupe en particulier
Les webhooks qui s’abonnent à /groups/<groupID>/updateUsers ont la propriété updateUserNames incluse dans leur charge utile. La propriété updateUserNames indique les noms des utilisateurs dont les rôles de groupe ont été mis à jour, en renvoyant une liste de noms d’utilisateurs dans l’objet JSON properties.
Exemple
"properties": {
"updatedUserNames": [
"u1TestUser",
"u2TestUser"
]
}
Un élément est partagé avec un groupe
Les webhooks qui s’abonnent à /groups/<groupID>/itemShare ont la propriété sharedItems incluse dans leur charge utile. La propriété sharedItems indique l’attribut itemID et le type de l’élément partagé avec un groupe, en renvoyant ces informations dans l’objet JSON properties.
Exemple
"properties": {
"sharedItems": [
{
"itemId": "6cd80cb32d4a4b4d858a020e57fba7b1",
"itemType": "Map Package"
}
]
}
Le partage d’un élément avec un groupe donné est annulé
Les webhooks qui s’abonnent à /groups/<groupID>/itemUnshare ont la propriété unsharedItems incluse dans leur charge utile. La propriété unsharedItems indique l’attribut itemID et le type de l’élément dont le partage avec un groupe a été annulé, en renvoyant ces informations dans l’objet JSON .properties
Exemple
"properties": {
"unsharedItems": [
{
"itemId": "7dd95fadaec84859ab8ed1059e675e0c",
"itemType": "Image"
}
]
}
Événements des utilisateurs de l’organisation
La table suivante répertorie les déclencheurs d’événements pour les utilisateurs de l’organisation :
| Déclencheur d’événement | URI |
|---|---|
Tous les événements déclencheurs pour tous les utilisateurs du portail | /users |
Un utilisateur est ajouté à l’organisation | /users/add |
N’importe quel utilisateur s’est connecté au portail | /users/signin |
N’importe quel utilisateur s’est déconnecté du portail | /users/signout |
N’importe quel utilisateur est supprimé | /users/delete |
Le profil de n’importe quel utilisateur est mis à jour Remarque :Un événement de mise à jour est déclenché dès qu’une modification est apportée au profil de l’utilisateur. Toutefois, les modifications apportées au rôle d’un utilisateur, à un type d’utilisateur ou à une licence ne sont pas considérées comme une mise à jour du profil de l’utilisateur. | /users/update |
Le compte de n’importe quel utilisateur est désactivé | /users/disable |
Le compte de n’importe quel utilisateur est activé | /users/enable |
Un nouveau rôle est affecté à n’importe quel utilisateur | /users/updateUserRole |
Un nouveau type d’utilisateur est affecté à n’importe quel utilisateur | /users/updateUserLicenseType |
Une liste de comptes d’utilisateur est activée | /users/bulkEnable |
Une liste de comptes d’utilisateur est désactivée | /users/bulkDisable |
Tous les événements déclencheurs associés à un utilisateur en particulier | /users/<username> |
Un utilisateur donné s’est connecté au portail | /users/<username>/signIn |
Un utilisateur donné s’est déconnecté du portail | /users/<username>/signOut |
Un utilisateur en particulier est supprimé | /users/<username>/delete |
Le profil d’un utilisateur en particulier est mis à jour Remarque :Un événement de mise à jour est déclenché dès qu’une modification est apportée au profil de l’utilisateur. Toutefois, les modifications apportées au rôle d’un utilisateur, à un type d’utilisateur ou à une licence ne sont pas considérées comme une mise à jour du profil de l’utilisateur. | /users/<username>/update |
Le compte d’un utilisateur en particulier est désactivé | /users/<username>/disable |
Le compte d’un utilisateur en particulier est activé | /users/<username>/enable |
Un nouveau rôle est affecté à un utilisateur en particulier | /users/<username>/updateUserRole |
Un nouveau type d’utilisateur est affecté à un utilisateur en particulier | /users/<username>/updateUserLicenseType |
Propriétés des déclencheurs d’événements des utilisateurs
Certains des déclencheurs d’événements pour les utilisateurs de l’organisation renvoient des propriétés supplémentaires dans la charge utile. Les sections ci-dessous décrivent les propriétés supplémentaires des charges utiles pour ces déclencheurs.
Un nouveau rôle est affecté à un utilisateur en particulier
Les webhooks qui s’abonnent à /users/<username>/updateUserRole ont la propriété userRoleUpdatedTo incluse dans leur charge utile. La propriété userRoleUpdatedTo indique le nouveau rôle auquel l’utilisateur est affecté, en renvoyant le nouveau rôle dans l’objet JSON properties.
"properties": {
"userRoleUpdatedTo": ["New role"]
}
Un nouveau type d’utilisateur est affecté à un utilisateur en particulier
Les webhooks qui s’abonnent à /users/<username>/updateUserLicenseType ont la propriété userLicenseTypeUpdatedTo incluse dans leur charge utile. La propriété userLicenseTypeUpdatedTo indique le nouveau type d’utilisateur auquel un utilisateur est affecté, en renvoyant le nouveau type d’utilisateur dans l’objet JSON properties.
"properties": {
"userLicenseTypeUpdatedTo": ["Editor"]
}
Événements des rôles de l’organisation
La table suivante répertorie les déclencheurs d’événements pour les rôles d’utilisateur de l’organisation :
| Déclencheur d’événement | URI |
|---|---|
Tous les événements déclencheurs pour tous rôles du portail | /roles |
Un nouveau rôle est créé | /roles/add |
Un rôle existant est mis à jour Remarque :Un événement de mise à jour est déclenché dès qu’une modification est apportée aux rôles de votre organisation. | /roles/update |
Un rôle existant est supprimé | /roles/delete |
Propriétés des déclencheurs d’événements des rôles
Certains des déclencheurs d’événements pour les rôles de l’organisation renvoient des propriétés supplémentaires dans la charge utile. La section ci-dessous décrit les propriétés supplémentaires des charges utiles pour ces déclencheurs.
Un nouveau rôle est créé
Les webhooks qui s’abonnent au déclencheur d’événement /roles/add ont la propriété name incluse dans leur charge utile. La propriété name indique le nom du rôle qui a été créé, en renvoyant le nom du rôle dans l’objet JSON properties.
Exemple
"properties": {
"name": ["New role"]
}
Événements de service d’entités
La table suivante répertorie les déclencheurs d’événements pour les webhooks de service d’entités :
| Déclencheur d’événement | Valeur |
|---|---|
N’importe quel événement est déclenché | * |
Une nouvelle entité est créée | FeaturesCreated |
Une entité est mise à jour. | FeaturesUpdated |
Une entité est supprimée | FeaturesDeleted |
Une entité est modifiée (insertion, mise à jour ou suppression, par exemple) | FeaturesEdited |
Une pièce jointe est ajoutée à une entité | AttachmentsCreated |
Une pièce jointe à une entité est mise à jour | AttachmentsUpdated |
Une pièce jointe à une entité est supprimée | AttachmentsDeleted |
La structure d’une couche d’entités est modifiée | LayerSchemaChanged |
La définition d’une couche d’entités est modifiée | LayerDefinitionChanged |
La définition d’un service d’entités est modifiée | FeatureServiceDefinitionChanged |
Vous avez un commentaire à formuler concernant cette rubrique ?