Create enterprise webhook

post/api/v2/enterprise/{enterpriseId}/webhooks

Create a webhook that will fire for any webhook type associated with the enterprise. Must be an enterprise admin to perform this action.

Path Parameters

  • enterpriseIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Request Body

type string required
Allowed value: bankAccount
url string <uri>required
Example: https://your.server.com/user_webhook
label string

200 Response

id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
label string
Example: Test Webhook
created string <date-time>
Example: 2018-05-05T19:46:22.019Z
coin string
A cryptocurrency or token ticker symbol.
Example: btc
type string
Event type to listen to.
Allowed values: txRequest txRequestTransaction transfer transaction pendingapproval address_confirmation lowFee
Example: transfer
url string <uri>required
Example: https://your.server.com/webhook
version integer
2 for coins running on API v2.
Example: 2
numConfirmations integer
Example: 6
state string
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
lastAttempt string <date-time>
Example: 2018-05-05T19:46:22.019Z
failingSince string <date-time>
Example: 2018-05-05T19:46:22.019Z
successiveFailedAttempts integer
Example: 0
walletId string
allowBlockedHosts boolean
allToken boolean
txRequestStates array[string]
If present, only transaction request state changes from the list will trigger notifications. If not present, all transaction request state changes will trigger notifications.
Allowed values: initialized pendingApproval pendingUserCommitment pendingUserRShare pendingUserGShare readyToSend pendingUserSignature pendingDelivery signed delivered canceled rejected failed
txRequestTransactionStates array[string]
If present, only transaction request transaction state changes from the list will trigger notifications. If not present, all transaction request transaction state changes will trigger notifications.
Allowed values: initialized pendingSignature eddsaPendingCommitment eddsaPendingRShare eddsaPendingGShare readyToCombineShares signed held delivered invalidSignature rejected ecdsaMPCv2Round1 ecdsaMPCv2Round2 ecdsaMPCv2Round3
identityStatus array[string]
If present, only identity status changes from the list will trigger notifications. If not present, all identity status changes will trigger notifications.
Allowed values: approved declined input error ssn error gov id error ssn verified gov id verified evaluating submission awaiting document upload records uploaded in review incomplete verifications awaiting signature signature submitted initiating additional information submitted
userKycState array[string]
If present, only user kyc state changes from the list will trigger notifications. If not present, all kyc state changes will trigger notifications.
Allowed values: approved pending rejected
enterpriseKycState array[string]
If present, only enterprise kyc state changes from the list will trigger notifications. If not present, all kyc state changes will trigger notifications.
Allowed values: approved pending rejected

403 Response

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