- URL:https://[root]/portals/[portalID]/webhooks/settings/update(POST only)
- Version Introduced:10.7
Example usage
Below is a sample ArcGIS Enterprise POST request for the update operation:
POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/webhooks/settings/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
notificationAttempts=3¬ificationTimeOutInSeconds=10¬ificationElapsedTimeInSeconds=30&f=pjsonDescription
The update operation adjusts several advanced parameters that can customize the performance of webhooks, such as specifying the number of delivery attempts, notification time, and time between delivery attempts. Once modified, the changes will be applied to all configured organization webhooks.
Note:
ArcGIS Enterprise supports organization, feature service, and geoprocessing webhooks. The ArcGIS Portal Directory allows for the creation and management of organization webhooks, whereas the ArcGIS Server Administrative API Directory supports the creation and management of geoprocessing and feature service webhooks. For information on how to configure service webhooks in ArcGIS Enterprise, see either the ArcGIS Server Admin API webhook documentation or the Manage webhooks in ArcGIS Enterprise administrative documentation. ArcGIS Online also supports feature service webhooks, which are managed in the ArcGIS Online Administrative Services Directory. To learn more about ArcGIS Online feature service webhooks, see the Web Hooks API documentation.
Request parameters
| Parameter | Details |
|---|---|
| notificationAttempts | Determines how many attempts will be made to deliver a payload. By default, this is set to three attempts. This parameter accepts any integer in the range of 0-5. Example |
| notificationTimeOutInSeconds | Specifies the length of time (in seconds) that the portal will wait to receive a response. By default, this is set to 10 seconds. This parameter accepts any integer in the range of 0-60. Example |
| notificationElapsedTimeInSeconds | Defines the amount of time between each payload delivery attempt. By default, this is set to 5 seconds. This parameter accepts any integer in the range of 1-100. Example |
| f | The response format. The default format is html. Values: html | json | pjson |
JSON Response example
{
"success": true
}