Get Notification
Retrieves a single notification or autogenerated report’s details.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
Notification ID.
Response
ID for the paypoint or organization that owns the notification.
"123"
Entity owner type. Accepted values:
0
: Organization/partner2
: Paypoint
0
, 2
0
Method to use to send the notification to the target.
email
, sms
, web
, report-email
, report-web
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
one-time
, daily
, weekly
, biweekly
, monthly
, quarterly
, semiannually
, annually
, untilcancelled
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.
Custom descriptor of source of notification.
100
"api"
Status of notification:
0
: Inactive1
: Active
0
, 1
Notification content.
The notification's Payabli identifier. This is the ID used to manage the notifcation.
1414
Name of entity owner of notification.
"The Pilgrim Planner"
Timestamp of when notification was created.
"2022-07-01 15:00:01"
Timestamp of when notification was last updated.
"2022-07-01 15:00:01"
Was this page helpful?