POST
/
Notification
curl --request POST \
  --url https://api-sandbox.payabli.com/api/Notification \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "content": {
    "timeZone": -5,
    "fileFormat": "json",
    "eventType": "CreatedApplication",
    "webHeaderParameters": null,
    "internalData": null
  },
  "ownerId": "236",
  "ownerType": 0,
  "method": "web",
  "frequency": "untilcancelled",
  "target": "https://webhook.site/2871b8f8-edc7-441a-b376-98d8c8e33275",
  "status": 1
}'
{
  "responseCode": 1,
  "pageIdentifier": null,
  "isSuccess": true,
  "responseText": "Success",
  "responseData": 872934
}

Authorizations

​
requestToken
string
header
required

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

Body

Build the notification by adding details in the notificationData object.

Information about the standard notification configuration (email, sms, web).

​
ownerId
string | null
required

ID for the paypoint or organization that owns the notification.

Example:

"123"

​
ownerType
enum<integer>
required

Entity owner type. Accepted values:

  • 0: Organization/partner
  • 2: Paypoint
Available options:
0,
2
Example:

0

​
method
enum<string>
required

Get near-instant notifications via email, SMS, or webhooks for important events like new payment disputes, merchant activations, fraud alerts, approved transactions, settlement history, vendor payouts, and more. Use webhooks with notifications to get real-time updates and automate operations based on key those key events. See Notifications for more.

Available options:
email,
sms,
web
Example:

"web"

​
target
string
required

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.
​
frequency
enum<string>
required
Available options:
one-time,
untilcancelled
Example:

"one-time"

​
status
enum<integer> | null

Status of notification:

  • 0: Inactive
  • 1: Active
Available options:
0,
1
​
content
object

Response

200
application/json
Success
​
responseCode
integer | null

Code for the response. Learn more in API Response Codes.

Example:

1

​
pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

​
isSuccess
boolean

If isSuccess = true, responseData contains the notification identifier.

If isSuccess = false, responseData contains the reason for the error.

Example:

true

​
responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

​
responseData

When the request was successful, this contains the notification ID, or nID used to manage the notifcation.

Example:

"1894232"

Was this page helpful?