- URL:https://[root]/portals/[portalID]/webhooks/[webhookID]/update
- Version Introduced:10.7
Example usage
The following is a sample ArcGIS Enterprise POST request for the update operation:
POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/webhooks/ef98412f3555432aa42d3aecc81c633a/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
name=Microsoft Flow&url=https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow&secret=12345ABCDE&config={"deactivationPolicy":{"numberOfFailures": 5,"daysInPast": 5}}&events=/items,/users&f=pjson
Description
The update operation allows administrators to update any of the previously configured parameters for an organization webhook.
Request parameters
Parameter | Details |
---|---|
name (Required) | The name of the webhook. Example
|
url (Required) | The payload URL. Note:The payload URL is not required when configuring a webhook for notebooks, as it is automatically derived by the system. Example
|
secret (Optional) | A user-defined element that can be added to the payload to help authenticate the message on your receiver. Example
|
config (Optional) | The configuration properties for the webhook. Example without properties
Notebook example with properties
|
events (Required) | The URI representation of an event that will trigger the webhook. For more information, see the Supported trigger events section below. Example
|
f | The response format. The default format is html. Values: html | json | pjson |
Supported trigger events
You can use the events parameter to manually define the events that will trigger the webhook. Trigger events are divided into the following categories:
Item
The item events that can be updated vary between item types, and there are unique actions that trigger the update operation. For example, if the item is a web map, updating the tag, configuring a pop-up, or changing the basemap are all update events that will trigger the webhook.
The following table lists the trigger events for supported portal items, which include web maps, web apps, layers, packages, and PDFs:
Trigger event | URI example | Properties |
---|---|---|
All trigger events for all items. | /items | |
An item is added to the portal. | /items/add | |
Any item is deleted. | /items/delete | |
Any item is updated. | /items/update | |
Any item is moved or its ownership is changed. | /items/move | |
Any item is published. | /items/publish | |
Any item is shared. | /items/share | |
Any item is unshared. | /items/unshare | |
The ownership of any item has been reassigned. | /items/reassign | |
All trigger events for a specific item. | /items/<itemID> | |
A specific item is deleted. | /items/<itemID>/delete | |
A specific item's properties are updated. | /items/<itemID>/update | |
A specific item's ownership is changed or the item is moved. | /items/<itemID>/move | |
A specific item is published. | /items/<itemID>/publish | |
A specific item is shared. | /items/<itemID>/share | sharedToGroups—How an item is shared (groupID, Organization, or Everyone) Examples, formatted for readability |
A specific item is unshared. | /items/<itemID>/unshare | unsharedFromGroups—How an item is unshared (groupID, Organization, or Everyone) Examples, formatted for readability
|
The ownership of a specific item has been reassigned. | /items/<itemID>/reassign |
Group
General changes made to the group settings constitute an update. For example, changing a group's access triggers an update event.
The following table lists the trigger events associated with groups:
Trigger event | URI example | Properties |
---|---|---|
All trigger events for all groups. | /groups | |
A group is added. | /groups/add | |
Any group is updated. | /groups/update | |
Any group is deleted. | /groups/delete | |
Delete Protection is enabled for any group. | /groups/protect | |
Delete Protection is disabled for any group. | /groups/unprotect | |
A user is invited to any group. | /groups/invite | |
A user is added to any group. | /groups/addUsers | |
A user is removed from any group. | /groups/removeUsers | |
A user's role is updated in any group. | /groups/updateUsers | |
The ownership for any group has been reassigned. | /groups/reassign | |
An item is shared to any group. | /groups/itemShare | |
An item is unshared from any group. | /groups/itemUnshare | |
All trigger events for a specific group. | /groups/<groupID> | |
A specific group is updated. | /groups/<groupID>/update | |
A specific group is deleted. | /groups/<groupID>/delete | |
Delete Protection is enabled for a specific group. | /groups/<groupID>/protect | |
Delete Protection is disabled for a specific group. | /groups/<groupID>/unprotect | |
A user is invited to a specific group. | /groups/<groupID>/invite | invitedUserNames—The usernames of users invited to a group Example, formatted for readability
|
A user is added to a specific group. | /groups/<groupID>/addUsers | addedUserNames—The usernames of users who have been added to a group Example, formatted for readability
|
A user is removed from a specific group. | /groups/<groupID>/removeUsers | removeUserNames—The usernames of users removed from a group Example, formatted for readability
|
A user's role is updated in a specific group. | /groups/<groupID>/updateUsers | updateUserNames—The user names of users whose group roles have been updated Example, formatted for readability
|
The ownership for a specific group has been reassigned. | /groups/<groupID>/reassign | |
An item is shared to a group. | /groups/<groupID>/itemShare | sharedItems—The itemID and item type of the item shared to a group Example, formatted for readability
|
An item is unshared from a specific group. | /groups/<groupID>/itemUnshare | unsharedItems—The itemID and item type of the item unshared from a group Example, formatted for readability
|
User
An update event is triggered anytime a change is made to the user's profile. However, changes made to a user's role, user type, or license are not considered an update to the user's profile.
The following table lists the trigger events associated with users:
Trigger event | URI example | Properties |
---|---|---|
All trigger events for all users in the portal. | /users | |
A user is added to the organization. | /users/add | |
Any user has signed in to the portal. | /users/signin | |
Any user has signed out of the portal. | /users/signout | |
Any user is deleted. | /users/delete | |
Any user's profile is updated. | /users/update | |
Any user's account is disabled. | /users/disable | |
Any user's account is enabled. | /users/enable | |
Any user has been assigned a new role. | /users/updateUserRole | |
Any user has been assigned a new user type. | /users/updateUserLicenseType | |
A list of user accounts has been enabled. | /users/bulkEnable | |
A list of user accounts has been disabled. | /users/bulkDisable | |
All trigger events associated with a specific user. | /users/<username> | |
A specified user has signed in to the portal. | /users/<username>/signin | |
A specified user has signed out of the portal. | /users/<username>/signout | |
A specific user is deleted. | /users/<username>/delete | |
A specific user's profile is updated. | /users/<username>/update | |
A specific user's account is disabled. | /users/<username>/disable | |
A specific user's account is enabled. | /users/<username>/enable | |
A specific user has been assigned a new role. | /users/<username>/updateUserRole | userRoleUpdatedTo—The new role the user has been assigned to Example, formatted for readability
|
A specific user has been assigned a new user type. | /users/<username>/updateUserLicenseType | userLicenseTypeUpdatedTo—The new user type that a user has been assigned to Example, formatted for readability
|
Role
An update event is triggered anytime a change is made to your organization's roles.
The following table lists the trigger events associated with user roles:
Trigger event | URI example | Properties |
---|---|---|
All trigger events for all roles in the portal. | /roles | |
A new role is created. | /roles/add | name—The name of the role that has been created, updated, or deleted Example, formatted for readability
|
An existing role is updated. | /roles/update | |
An existing role is deleted. | /roles/delete |
JSON Response example
{
"success": true
}