Ctrl+K

List wallet webhook notifications

get/api/v2/{coin}/wallet/{walletId}/webhooks/notifications

List webhook notifications for a wallet. Returns notifications that were triggered by webhooks on the specified wallet.

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: btc
  • walletIdstringRequired
    The wallet ID.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • prevIdstring
    Return the next batch of results, based on the `nextBatchPrevId` value from the previous batch.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • limitinteger
    Maximum number of results to return.
    Example: 25
    Minimum: >= 1
  • hashstring
    Filter notifications by transaction hash.

200 Response

webhookNotifications array[object]
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
type string
Event type to listen to.
Allowed values: txRequest txRequestTransaction transfer transaction transactionRemoved transactionExpire unspentExpiry pendingapproval address_confirmation lowFee block admin circuitBreaker transaction_finality_on_l1 lowFeeAddressBalance stuckTx
Example: transfer
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organization string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
bankAccount string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
url string <uri>
Example: https://your.server.com/webhook
hash string
A transaction hash for transactions, or a block hash for block notifications.
Example: 1311768467294899700
coin string
A cryptocurrency or token ticker symbol.
Example: btc
transfer string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
state string
If `failed`, webhook notification failed to connect with the target URL. If `new`, webhook notification was newly generated, in response to an event. If `pending`, webhook notification is awaiting processing by the webhook worker. If `processed`, webhook notification successfully sent to target URL. If `unconfirmed`, webhook notification is awaiting confirmation on the blockchain.
Allowed values: failed new pending processed unconfirmed
Example: new
simulation boolean
Example: false
retries integer
The number of retries that have been attempted for this webhook notification.
Example: 0
webhook string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
updateAt string <date-time>
Example: {}
nextAttempt string <date-time>
Example: {}
version integer
Example: 2
idempotencyKey string
A unique id that can be used to de-duplicate notifications.
nextBatchPrevId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code