WePay logo
      Nothing Found

Get a collection of notification preferences

get/notification_preferences

The GET /notification_preferences call allows your platform to look up a collection of notification preferences. Notification preferences allow your platform to subscribe to notifications based on an event topic.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements from this page.

page_size
integer [ 1 .. 50 ]
Default: 10

Return no more than this many elements per page. If not specified, page_size defaults to 10. Maximum value allowed is 50.

create_time_start
integer <int64> >= 0

The timestamp for the start of the search window.

create_time_end
integer <int64> >= 0

The timestamp for the end of the search window.

type
string
Default: "notification"

Type of notification preference

Value: Description
notification
status
string
Default: "active"

Status of the notification. Possible values are: active, unreachable, deleted. Note: The default state is active.

Enum: Description
active

The notification preference is active and ready to be used.

deleted

The notification preference has already been deleted.

… 1 more
topic
string

The event topic of the notification preference to search for.

Enum: Description
accounts.*

Get Notification Preferences for all accounts topics.

accounts.additional_details

Fires when there is any update on an account's details, such as tax events.

… 78 more
callback_uri
string

A valid URL where notification webhooks are sent.

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
previous
required
string or null

An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page.

next
required
string or null

An opaque path for the next page of results. Perform an HTTP GET to obtain the next page.

required
Array of objects unique

An array of notification preference objects.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": null,
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "callback_uri": "https://example.com/disputes_created",
      • "create_time": 1509407823974,
      • "id": "9164a672-8128-4163-8f66-04a9172d2911",
      • "owner": {
        • "id": "74582",
        • "path": null,
        • "resource": "applications"
        },
      • "path": "/notification_preferences/9164a672-8128-4163-8f66-04a9172d2911",
      • "resource": "notification_preferences",
      • "status": "active",
      • "topic": "disputes.created",
      • "api_version": "3.0"
      }
    ]
}