Notificationlogs

Search Notification Logs

Search notification logs with filtering and pagination.

  • Start date and end date cannot be more than 30 days apart
  • Either orgId or paypointId must be provided

This endpoint requires the notifications_create OR notifications_read permission.

post/v2/notificationlogs

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/v2/notificationlogs
  • Auth: HTTP bearer

Query parameters

PageSizeinteger

Number of records on each response page.

Pageinteger

The page number to retrieve. Defaults to 1 if not provided.

Request body

startDatestring date-time required

The start date for the search. Can't be more than 30 days before endDate.

endDatestring date-time required

The end date for the search. Can't be more than 30 days after startDate.

notificationEventstring

The event to filter by, such as approvedpayment. Case-insensitive.

succeededboolean

Filter by delivery outcome. Set to false to return only failed notifications.

orgIdinteger

The ID of the organization to filter by. Either orgId or paypointId is required.

paypointIdinteger

The ID of the paypoint to filter by. Either orgId or paypointId is required.

Response

Success

organizationLogostring required

The URL of the organization's logo.

organizationFavIconstring required

The URL of the organization's browser tab icon.

paypointLogostring required

The URL of the paypoint's logo.

notificationTypeinteger required

The notification's delivery method — 1 (Email), 2 (SMS), or 3 (Webhook).

organizationNamestring required

The name of the organization the notification belongs to.

paypointNamestring required

The name of the paypoint the notification is related to. Empty for organization-level notifications.

requestIdstring required

The identifier for the delivery request.

idstring uuid required

The unique identifier for the notification.

orgIdinteger nullable required

The ID of the organization the notification belongs to.

paypointIdinteger nullable required

The ID of the paypoint the notification is related to. Null for organization-level notifications.

notificationEventstring nullable required

The event that triggered the notification, such as approvedpayment.

targetstring nullable required

The target the notification was delivered to, such as a webhook URL, email address, or phone number.

responseStatusCodeinteger required

The HTTP status code the target returned, such as 200. Returns 0 when the target sent no response.

responseStatusstring required

The delivery status message, such as OK when the notification succeeded, Dropped when it failed, or No response received from server. when the target sent no response.

successboolean required

Indicates whether the notification was delivered successfully.

jobDatastring nullable required

The body of the notification.

createdDatestring date-time required

The date and time when the notification was created.

successDatestring date-time nullable required

The date and time when the notification was delivered successfully. Null if it hasn't succeeded.

lastFailedDatestring date-time nullable required

The date and time when the notification last failed. Null if it hasn't failed.

isInProgressboolean required

Indicates whether the notification is currently being sent.

Changes

No recorded changes to this operation across all 1 revision of this API.