Skip to main content
GET
/
webhooks
/
events
/
definitions
import cobo_waas2
from cobo_waas2.models.list_webhook_event_definitions200_response_inner import (
    ListWebhookEventDefinitions200ResponseInner,
)
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.DevelopersWebhooksApi(api_client)

    try:
        # Get webhook event types
        api_response = api_instance.list_webhook_event_definitions()
        print(
            "The response of DevelopersWebhooksApi->list_webhook_event_definitions:\n"
        )
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling DevelopersWebhooksApi->list_webhook_event_definitions: %s\n"
            % e
        )

[
  {
    "event_type": "wallets.transaction.created",
    "description": "Occurs when the transaction status is updated"
  }
]
import cobo_waas2
from cobo_waas2.models.list_webhook_event_definitions200_response_inner import (
    ListWebhookEventDefinitions200ResponseInner,
)
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.DevelopersWebhooksApi(api_client)

    try:
        # Get webhook event types
        api_response = api_instance.list_webhook_event_definitions()
        print(
            "The response of DevelopersWebhooksApi->list_webhook_event_definitions:\n"
        )
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling DevelopersWebhooksApi->list_webhook_event_definitions: %s\n"
            % e
        )

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.

Response

The request was successful.

event_type
enum<string>

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

Currently, you can only trigger test webhook events with the event data types Transaction and TSSRequest.

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.token_listing.failed,
wallets.token_listing.succeeded,
mpc_vaults.created,
fee_station.transaction.created,
fee_station.transaction.updated,
fee_station.transaction.failed,
fee_station.transaction.succeeded,
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.status.updated,
payment.refund.status.updated,
payment.settlement.status.updated,
payment.address.updated,
compliance.disposition.status.updated
Example:

"wallets.transaction.created"

description
string

The description of the webhook event type.

Example:

"Occurs when the transaction status is updated"