REST APIUser Management NotificationNotification Webhooks

GET

Retrieves paginated notification history for a specific webhook with optional filters for status, date range, hash, and transfer ID.

Path Params

  • webhookId string required
    The webhook ID

Query Params

  • webhookNotificationId string
    Filter by specific webhook notification UUID
  • notificationRequestId string
    Filter by notification request ID (Cuid)
  • start string
    Start timestamp (default: now - 1 day). Supports ISO 8601 datetime (2023-01-01T00:00:00Z) or simple date (2023-01-01).
  • end string
    End timestamp (default: now). Supports ISO 8601 datetime (2023-12-31T23:59:59Z) or simple date (2023-12-31).
  • hash string
    Filter by transaction hash
  • transferId string
    Filter by transfer ID
  • status string enum
    Filter by notification status
    pendingprocessingsentfailedskipped
  • limit integer int32 required
    Number of records to return (default 25, max 1000)

    >= 1 · <= 1000

  • offset integer int32 required
    Number of records to skip (default 0)

    >= 0

Responses

200
Webhook notification history retrieved successfully

Response Body

object

  • notifications array of objects required
    notifications object
    • id string uuid required
    • notificationRequestId string required
    • url string required
    • payload string required
    • type string required
    • status string required
    • retries integer int32 required
    • createdAt string date-time required
    • updatedAt string date-time required
    • response map of objects
      response object
      • <key> object
    • coin string
    • walletId string
    • enterpriseId string
    • organizationId string
    • transferId string
    • hash string
  • total integer int64 required
  • limit integer int32 required
  • offset integer int32 required
400
Invalid request parameters

Response Body

object

Bad request error response
  • name string enum required
    Error code
    ValidationFailedIllegalArgumentBadRequestDataIntegrityErrorNotImplementedErrorRETRIGGER_RATE_LIMITEDUSER_CREATION_FAILEDUSER_FALLBACK_FAILED
  • error string required
    Human-readable error message
  • status integer enum int32 required
    HTTP status code
    400
403
Access denied

Response Body

object

Forbidden error response
  • name string enum required
    Error code
    AccessDenied
  • error string required
    Human-readable error message
  • status integer enum int32 required
    HTTP status code
    403
404
Webhook not found

Response Body

object

Not found error response
  • name string enum required
    Error code
    NotFound
  • error string required
    Human-readable error message
  • status integer enum int32 required
    HTTP status code
    404
500
Unexpected error occurred

Response Body

object

Internal server error response
  • name string enum required
    Error code
    UnexpectedErrorThirdPartyErrorDatabaseErrorUSER_FALLBACK_TIMEOUT
  • error string required
    Human-readable error message
  • status integer enum int32 required
    HTTP status code
    500