Retrieve subscriptions
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Query Parameters
(Optional) The id of the webhook subcription you want to retrieve. If omitted, all subscriptions will be returned.
Path Parameters
This is your organization’s MyPreferences account Id.
Response
The request was successfully processed.
Response Attributes
System generated read-only value that uniquely identifies the webhook subscription.
Name of the subscription.
Description of the subscription.
LocaleId used to return localized name and description for the event.
URL associated with the subscription to receive POST requests for events. Only secure (htttps) URL's are supported.
Collection of event subscriptions.
The status of the subscription whether it's active and sending notifications, paused, or inactive.
ActivePausedIf set to true, the event notifications will only include the main event information without any data associated with it. Receiving systems must retrieve the data by other means.
Indicates whether the webhook subscription is active or not.
If set to true, the system delivers events generated during the paused period, up to a maximum of 15 days, prior to resumption.
Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.
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.
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
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.
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.
Response Attributes
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
Response