WePay logo
      Nothing Found

Create a notification preference

post/notification_preferences

The POST /notification_preferences call allows your platform to create a new notification preference. Notification preferences allow your platform to subscribe to notifications based on an event topic.

SecurityappIdAuth and appTokenAuth
Request
header Parameters
Api-Version
required
string
Example: 3.0
Content-Type
required
stringapplication/json
Example: application/json
Unique-Key
string
Request Body schema: application/json
topic
required
string

The event topic the notification preference is subscribed to.

Enum: Description
accounts.additional_details

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

accounts.capabilities.updated

Fires when an upcoming or current issue occurs for any of any account's capabilities, or when a capability's enabled value changes.

… 63 more
callback_uri
required
string <= 2063 characters ^https?://.+$

A valid, publicly available URL that works as an endpoint for HTTPS requests. This cannot be a local host. If for notification preferences, must be HTTPS.

Responses
201
Response Schema: application/json
id
required
string
resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
notification_preferences
path
required
string
create_time
required
integer <int64> >= 0
topic
required
string
callback_uri
required
string
status
required
string

Status of the notification preference. Possible values are: active, unreachable, deleted.

Enum: Description
active

The notification preference is active and ready to be used.

deleted

The notification preference has already been deleted.

… 1 more
api_version
string
object

This owner resource and owner path of the object.

400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{}
Response samples
application/json
{
  • "callback_uri": "https://example.com/payments",
  • "create_time": 1509407823974,
  • "id": "fee568cd-8ac6-40f3-9623-91aba2c5d11a",
  • "owner": {
    • "id": "74582",
    • "path": null,
    • "resource": "applications"
    },
  • "path": "/notification_preferences/fee568cd-8ac6-40f3-9623-91aba2c5d11a",
  • "resource": "notification_preferences",
  • "status": "active",
  • "topic": "payments.completed",
  • "api_version": "3.0"
}