Skip to main content
GET
Try Cobo WaaS Skill in your AI coding assistant (Claude Code, Cursor, etc.). Describe your needs in natural language to auto-generate production-ready SDK code and debug faster 🚀

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Path Parameters

endpoint_id
string<uuid>
required

The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling List webhook endpoints.

Response

The request was successful.

The information about a webhook endpoint.

url
string<url>
required

The webhook endpoint URL.

Maximum string length: 500
Example:

"https://example.com/webhook"

subscribed_events
enum<string>[]
required

The event types subscribed by a webhook endpoint.

The event type. To learn the trigger condition of each event type, refer to Webhook event types and event data.

Available options:
wallets.transaction.created,
wallets.transaction.updated,
wallets.transaction.failed,
wallets.transaction.succeeded,
wallets.mpc.tss_request.created,
wallets.mpc.tss_request.updated,
wallets.mpc.tss_request.failed,
wallets.mpc.tss_request.succeeded,
wallets.addresses.created,
wallets.created,
wallets.updated,
wallets.token_listing.failed,
wallets.token_listing.succeeded,
mpc_vaults.created,
mpc_vaults.updated,
mpc_vaults.deleted,
organizations.updated,
fee_station.transaction.created,
fee_station.transaction.updated,
fee_station.transaction.failed,
fee_station.transaction.succeeded,
fee_station.fiat_transaction.created,
wallet.token.enabled,
wallet.chain.enabled,
wallet.mpc.balance.updated,
wallet.web3.balance.updated,
wallet.token.disabled,
wallet.chain.disabled,
token.suspended.deposit,
token.suspended.withdraw,
payment.transaction.created,
payment.transaction.late,
payment.transaction.completed,
payment.transaction.held,
payment.transaction.failed,
payment.account.balance.updated,
payment.status.updated,
payment.order.status.updated,
payment.refund.status.updated,
payment.settlement.status.updated,
payment.payout.status.updated,
payment.address.updated,
payment.subscription.status.updated,
payment.charge.status.updated,
payment.bulk_send.status.updated,
payment.transaction.external.created,
payment.transaction.external.completed,
payment.transaction.settlement_network.created,
payment.transaction.settlement_network.completed,
compliance.disposition.status.updated,
compliance.kyt.screenings.status.updated,
compliance.kya.screenings.status.updated
created_timestamp
integer<int64>
required

The time when the endpoint was registered, in Unix timestamp format, measured in seconds.

Example:

1701396866000

status
enum<string>
required

The webhook endpoint status. Possible values include:

  • STATUS_ACTIVE: The endpoint is currently in use.
  • STATUS_INACTIVE: The endpoint has been revoked and can no longer receive webhook events.
  • STATUS_PENDING_ACTIVE: The request to create the endpoint is awaiting approval. After the approval, the endpoint will be available for use.
  • STATUS_PENDING_INACTIVE: The request to revoke the endpoint is awaiting approval. After the approval,the endpoint will no longer receive webhook events.
  • STATUS_PENDING_UPDATE: The request to update the endpoint is awaiting approval. After the approval, the endpoint will be updated.
  • STATUS_REJECT_ACTIVE: The request to create the endpoint has been rejected.
Available options:
STATUS_ACTIVE,
STATUS_INACTIVE,
STATUS_PENDING_ACTIVE,
STATUS_PENDING_INACTIVE,
STATUS_PENDING_UPDATE,
STATUS_REJECT_ACTIVE
Example:

"STATUS_ACTIVE"

endpoint_id
string<uuid>

The webhook endpoint ID.

Example:

"8f2e919a-6a7b-4a9b-8c1a-4c0b3f5b8b1f"

description
string

The description of the webhook endpoint.

Example:

"My webhook endpoint"