GET
/
Notification
/
{nId}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

nId
string
required

Notification ID.

Response

200 - application/json
content
object

Notification content.

createdAt
string

Timestamp of when notification was created.

frequency
enum<string> | null

Frequency for notification. For notifications using the email ,sms, or web method, the allowed values are:

  • untilcancelled
  • one-time

For notifications using the report-email or report-web method, the allowed values are:

  • one-time
  • daily
  • weekly
  • biweekly
  • monthly
  • quarterly
  • semiannually
  • annually
Available options:
one-time,
daily,
weekly,
biweekly,
monthly,
quarterly,
semiannually,
annually,
untilcancelled
lastUpdated
string | null

Timestamp of when notification was last updated.

method
enum<string>

Method to use to send the notification to the target.

Available options:
email,
sms,
web,
report-email,
report-web
notificationId
integer

The notification's Payabli identifier. This is the ID used to manage the notifcation.

ownerId
string | null

ID for the paypoint or organization that owns the notification.

ownerName
string | null

Name of entity owner of notification.

ownerType
enum<integer>

Entity owner type. Accepted values:

  • 0: Organization/partner
  • 2: Paypoint
Available options:
0,
2
source
string | null

Custom descriptor of source of notification.

Maximum length: 100
status
enum<integer> | null

Status of notification:

  • 0: Inactive
  • 1: Active
Available options:
0,
1
target
string | null

Specify the notification target.

For method=email the expected value is a list of email addresses separated by semicolon.

For method=sms the expected value is a list of phone numbers separated by semicolon.

For method=web. the expected value is a valid and complete URL. Webhooks support only standard HTTP ports: 80, 443, 8080, or 4443.