Admin List webhooks for an organization

get/api/v2/admin/organization/{organizationId}/webhook

List all webhooks for the specified organization.

Path Parameters

  • organizationIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Query Parameters

  • typestring
    Enum: txRequest txRequestTransaction transfer transaction transactionRemoved transactionExpire pendingapproval block admin address_confirmation lowFee circuitBreaker lowFeeAddressBalance wallet_confirmation bankAccount userKycState enterpriseKycState identityStatus idvStatus accessToken accountCreated contractSigned fundsDeposited kycResult policyBalanceChange reversal transaction_finality_on_l1 stuckTx tradeOrder unspentExpiry twoStepTransfer twoStepDeposit twoStepWithdrawal
  • prevIdstring
    Min length: >= 1 characters
  • limitstring<number>

200 Response

webhooks array[object] required
id string required
created string <date-time>required
url string required
version number required
scope string required
Allowed values: wallet enterprise organization
state string required
If 'active', indicates the webhook can trigger and send to the URL. If 'suspended', indicates the webhook can't trigger.
Allowed values: active suspended
Example: active
successiveFailedAttempts number required
listenToFailureStates boolean required
coin string
label string
walletId string
enterpriseId string
organizationId string
userId string
type string
Allowed values: txRequest txRequestTransaction transfer transaction transactionRemoved transactionExpire pendingapproval block admin address_confirmation lowFee circuitBreaker lowFeeAddressBalance wallet_confirmation bankAccount userKycState enterpriseKycState identityStatus idvStatus accessToken accountCreated contractSigned fundsDeposited kycResult policyBalanceChange reversal transaction_finality_on_l1 stuckTx tradeOrder unspentExpiry twoStepTransfer twoStepDeposit twoStepWithdrawal
numConfirmations number
lastAttempt string <date-time>
failingSince string <date-time>
allToken boolean
txRequestStates array[string]
If supplied, only transaction request state changes from the provided list will trigger notifications. If not provided, all transaction request state changes will trigger notifications.
Allowed values: pendingApproval canceled rejected initialized pendingDelivery delivered pendingUserSignature pendingUserCommitment pendingUserRShare pendingUserGShare readyToSend signed failed
txRequestTransactionStates array[string]
If supplied, only transaction request transaction state changes from the provided list will trigger notifications. If not provided, all transaction request transaction state changes will trigger notifications.
Allowed values: initialized pendingSignature eddsaPendingCommitment eddsaPendingRShare eddsaPendingGShare ecdsaMPCv2Round1 ecdsaMPCv2Round2 ecdsaMPCv2Round3 eddsaMPCv2Round1 eddsaMPCv2Round2 eddsaMPCv2Round3 readyToCombineShares signed held delivered invalidSignature rejected
nextBatchPrevId string

401 Response

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

403 Response

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

404 Response

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