API explorerChangelog
Overview

Sections

Theme switcher

Update webhook settings

This method allows you to update webhook message delivery settings.

The MaxConcurrentRequests determines the maximum number of messages that the EventsPublisherService will process in a single service cycle. It reads up to this specified number of messages and then sends them to the designated receiving URLs configured across all active webhook subscriptions.

Following the processing of these messages, the service engages in a "pause" based on the time specified under the Duration property. This means that after handling the specified number of messages, the service takes a break for the duration indicated before it resumes its cycle and processes additional messages.

The default settings for Max Concurrent Requests is "500", and Duration (in seconds) is "1".

  • The Min value for "Max Concurrent Requests" can be set to "50".
  • The Min value for "Duration (in seconds)" can be set to "1".
  • The Max value for "Max Concurrent Requests" can be set to "5000".
  • The Max value for "Duration (in seconds)" can be set to "300".

This setting is an account-level setting and applies to all webhook subscriptions within your MyPreferences account.

Header Parameters

Authorizationstring Required

Authorization token

Content-Typestring

Type of the data being sent in the request or the data that is expected in the response. Supports application/json.

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences account Id.

Body Parameters

Settingsobject

Webhook message delivery settings.

Show child attributes

Editedobject

Includes resource creation and modification details to track changes and auditability within MyPreferences.

Show child attributes

Response

200
Object
The request was successfully processed.

Response Attributes

Settingsobject

Webhook message delivery settings.

Show child attributes

Editedobject

Includes resource creation and modification details to track changes and auditability within MyPreferences.

Show child attributes

201
Object
Created
400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.

Response Attributes

Messagestring
Nullable:
True
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.

Response Attributes

Messagestring
Nullable:
True
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.

Response Attributes

Messagestring
Nullable:
True
404
Object
The requested resource cannot be found.  Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found.
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

Response Attributes

Messagestring
Nullable:
True
Was this section helpful?

What made this section unhelpful for you?

PUT

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?