Settings

URL:: https://<root>/services/webhooks/settings
Methods:: POST
Required Capability:: Access allowed with the "Organization Webhooks" privilege
Version Introduced:: 11.2

Description

The settings operation allows organization administrators to set the number of re-delivery attempts the system will make to deliver a payload to a receiver before the delivery is marked as a failure, as well as set the deactivation policy for service webhooks. The deactivation policy specifies the number of failures (numberOfFailures) that can occur over a specific number of days (daysInPast) before a service webhook is deactivated.

For example, if the policy is set to allow 5 failed attempts over 5 days, if there is 1 failed attempt every day for 5 days, the webhook will deactivate on the fifth day. If 3 failures occur one day, and then 2 failures occur the second day, the webhook would deactivate the second day. If 2 failures occur one day, no failures occur the second day, 2 failures occur the third day, but no failures occur the fourth or fifth day, the webhook will not deactivate. If failures occur the sixth day, that day is treated as the start of the next 5 day period, and if 3 more failed attempts occur within this new window of time the webhook will deactivate.

Request parameters

Parameter	Details
`notificationAttempts`	This value specifies the number of attempts that will be made to deliver the webhook payloads. By default, the payload will attempt to be delivered 3 times. The value for the attempts must be an integer between 1 and 5. Example Use dark colors for code blocksCopy `1 notificationAttempts=4`
`notificationTimeOutInSeconds`	This value specifies the length of time, in seconds, the system will wait to receive a response from the receiver. By default, the system will wait 10 seconds. The value for the number of seconds the system will wait must be an integer between 1 and 60 seconds. Example Use dark colors for code blocksCopy `1 notificationAttempts=30`
`notificationElapsedTimeInSeconds`	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 5 seconds if the previous attempt fails, until the number of attempts specified by the `notificationAttempts` parameter has been reached. The value must be an integer between 1 and 60. Example Use dark colors for code blocksCopy `1 notificationElapsedTimeInSeconds=30`
`numberOfFailures`	This value specifies the number of failures that can happen over a specific number of days (specified by the `daysInPast` parameter) before the webhook is deactivated. By default, the system will accept 5 failures over a number of days before the webhooks is deactivated. The value must be an integer between 1 and 30. Example Use dark colors for code blocksCopy `1 numberOfFailures=5`
`daysInPast`	This value specifies the number of days a specific number of failures (specified by the `numberOfFailures` parameter) can occur during before the webhook is deactivated. By default, the system will accept a specific number of failures over the course of 5 days. The value must be an integer between 1 and 30. Example Use dark colors for code blocksCopy `1 daysInPast=5`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample POST request for the settings operation:

Use dark colors for code blocksCopy
POST /webadaptor/admin/services/webhooks/settings HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

notificationAttempts=4&notificationTimeOutInSeconds=30&notificationElapsedTimeInSeconds=30&numberOfFailures=5&daysInPast=5&f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
  "notificationAttempts": 4,
  "notificationTimeOutInSeconds": 30,
  "notificationElapsedTimeInSeconds": 30,
  "daysInPast": 5,
  "numberOfFailures": 5,
  "status": "success"
}