API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve subscriptions

This method allows you to retrieve all webhook subscriptions. You can specify the SubscriptionId as a query parameter to retrieve a specific subscription.

Subscriptions that have been paused will also be returned.

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.

Query Parameters

subscriptionIdinteger

(Optional) The id of the webhook subcription you want to retrieve. If omitted, all subscriptions will be returned.

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences account Id.

Response

200
Object
The request was successfully processed.

Response Attributes

Idnumber

System generated read-only value that uniquely identifies the webhook subscription.

Namestring

Name of the subscription.

Descriptionstring

Description of the subscription.

LocaleIdstring

LocaleId used to return localized name and description for the event.

Urlstring

URL associated with the subscription to receive POST requests for events. Only secure (htttps) URL's are supported.

Subscriptionsarray

Collection of event subscriptions.

Statestring

The status of the subscription whether it's active and sending notifications, paused, or inactive.

Enum values:
Active
The webhook subscription is currently enabled and delivering events to the configured endpoint.
Paused
The webhook subscription is temporarily disabled and will not send any events until reactivated.
IsMinimizedstring

If 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.

IsActiveboolean

Indicates whether the webhook subscription is active or not.

CatchUpOnResumeboolean

If set to true, the system delivers events generated during the paused period, up to a maximum of 15 days, prior to resumption.

AlternateIdTypestring

Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.

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.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
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.
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.

Response Attributes

Messagestring
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?