Ctrl+K

Internal Get notification status

get/api/notifications/v1/internal/notification-status

Retrieves notification status information for a specific workflow type or transaction ID

Query Parameters

  • requestobjectRequired
    • notificationWorkflowNamestring
    • transactionIdstring
    • notificationIdempotencyKeystring
    • afterstring
    • beforestring
    • pageinteger<int32>Required
      Minimum: >= 1
    • limitinteger<int32>Required
      Minimum: >= 1
      Maximum: <= 100
    • orderstringRequired
      Pattern: ^(asc|desc)$
    • statusstring
    • isTransactionIdQuerybooleanRequired
    • isIdempotencyKeyQuerybooleanRequired
    • messageStatusstring
      Enum: PENDING QUEUED RUNNING COMPLETED FAILED DELAYED CANCELED MERGED SKIPPED PROCESSING
    • afterDateTimestring<date-time>
    • beforeDateTimestring<date-time>

200 Response

data array[object] required
messageRecordId string <uuid>required
notificationId string <uuid>required
channel string required
transactionId string required
status string required
createdAt string <date-time>required
updatedAt string <date-time>required
notificationIdempotencyKey string required
metadata object required
total integer <int32>required
page integer <int32>required
limit integer <int32>required
order string required