/settings/update: Update Webhook Settings

URL:
https://[root]/portals/[portalID]/webhooks/settings/update
Methods:
POST
Version Introduced:
10.7

Example usage

The following is a sample ArcGIS Enterprise POST request for the update operation:

1
2
3
4
5
6
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&notificationTimeOutInSeconds=10&notificationElapsedTimeInSeconds=30&f=pjson

Description

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.

Request parameters

ParameterDetails

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

1
notificationAttempts=3

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

1
notificationTimeOutInSeconds=10

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

1
notificationElapsedTimeInSeconds=5

f

The response format. The default format is html.

Values: html | json | pjson

JSON Response example

1
2
3
{
  "success": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close