Get log entry

GET

/v2/notificationlogs/:uuid

GET

/api/v2/notificationlogs/:uuid

$ curl https://api-sandbox.payabli.com/api/v2/notificationlogs/550e8400-e29b-41d4-a716-446655440000 \
>      -H "requestToken: <apiKey>"

1 {
2   "id": "550e8400-e29b-41d4-a716-446655440000",
3   "orgId": 123,
4   "paypointId": 3040,
5   "notificationEvent": "ActivatedMerchant",
6   "target": "https://webhook.example.com/payments",
7   "responseStatus": "200",
8   "success": true,
9   "jobData": "{\"transactionId\":\"txn_123\"}",
10   "createdDate": "2024-01-15T10:30:00Z",
11   "successDate": "2024-01-15T10:30:05Z",
12   "lastFailedDate": null,
13   "isInProgress": false,
14   "webHeaders": [
15     {
16       "key": "Content-Type",
17       "value": "application/json"
18     },
19     {
20       "key": "User-Agent",
21       "value": "PaymentSystem/1.0"
22     }
23   ],
24   "responseHeaders": [
25     {
26       "key": "Content-Type",
27       "value": [
28         "application/json"
29       ]
30     },
31     {
32       "key": "X-Request-ID",
33       "value": [
34         "req_abc123"
35       ]
36     }
37   ],
38   "responseContent": "{\"status\":\"received\",\"id\":\"wh_123\"}"
39 }

Get detailed information for a specific notification log entry. This endpoint requires the notifications_create OR notifications_read permission.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

uuidstringRequiredformat: "uuid"

The notification log entry.

Response

Success

idstringformat: "uuid"

The unique identifier for the notification.

orgIdlong or null

The ID of the organization that the notification belongs to.

paypointIdlong or null

The ID of the paypoint that the notification is related to.

notificationEventstring or null

The event that triggered the notification.

targetstring or null

The target URL for the notification.

responseStatusstring or null

The HTTP response status of the notification.

successboolean

Indicates whether the notification was successful.

jobDatastring or null

Contains the body of the notification.

createdDatedatetime

The date and time when the notification was created.

successDatedatetime or null

The date and time when the notification was successfully delivered.

lastFailedDatedatetime or null

The date and time when the notification last failed.

isInProgressboolean

Indicates whether the notification is currently in progress.

webHeaderslist of objects

responseHeaderslist of objects

responseContentstring

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error