- URL:
- https://<root>/WebHooks/webhookSettings
- Methods:
POST- Version Introduced:
- June, 2024
Description
The webhook settings can be configured to provide functions to update system level settings, and it is only accessible to default administrators or individuals with organization webhook privileges.
Request parameters
| Property | Details |
|---|---|
notification | Specifies the number of attempts that will be made to deliver the webhook payloads. By default, the system will attempt to deliver payloads once. The value for the attempts must be an integer between 1 and 5. |
notification | This value specifies the amount of time, in seconds, between each payload delivery attempt. By default, the system will attempt to deliver another payload after 10 seconds if the previous attempt fails, until the number of attempts specified for the setting has been reached. The |
number | This value specifies the number of failures that can occur over a specific number of days before the webhook is deactivated. By default, the system will accept 5. The value must be an integer between 1 and 10. |
f | The response format. The default response format is Values: |
Payload Tracking (for Deactivation Policy)
The service webhook will track the failed payload only. If the count of consecutive failures reaches the value specified for the number parameter, the webhook will be automatically deactivated and the failure log will be cleared right away.
If there is one successful payload delivery right after several failed deliveries, and the count of these failed delivery has not yet reached the value specified for the number parameter, the count of failure will reset to 0 and failure log will be cleared.
Example usage
Below is a sample request URL used to access the Webhooks resource:
https://myserver.domain.com/myTenant/ArcGIS/rest/admin/webhooks/webhooksettings?f=jsonJSON Response example
[
{
"notificationAttempts" : "5",
"notificationTimeOutInSeconds" : "3",
"numberOfFailures" : "5",
"status" : "success"
}
]