Skip to main content
POST
/
webhooks
/
events
/
trigger
import cobo_waas2
from cobo_waas2.models.trigger_test_webhook_event201_response import (
    TriggerTestWebhookEvent201Response,
)
from cobo_waas2.models.trigger_test_webhook_event_request import (
    TriggerTestWebhookEventRequest,
)
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)
    trigger_test_webhook_event_request = cobo_waas2.TriggerTestWebhookEventRequest(
        event_type="wallets.transaction.created"
    )

    try:
        # Trigger test event
        api_response = api_instance.trigger_test_webhook_event(
            trigger_test_webhook_event_request=trigger_test_webhook_event_request
        )
        print("The response of DevelopersWebhooksApi->trigger_test_webhook_event:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling DevelopersWebhooksApi->trigger_test_webhook_event: %s\n"
            % e
        )


{
  "triggered": true
}
import cobo_waas2
from cobo_waas2.models.trigger_test_webhook_event201_response import (
    TriggerTestWebhookEvent201Response,
)
from cobo_waas2.models.trigger_test_webhook_event_request import (
    TriggerTestWebhookEventRequest,
)
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)
    trigger_test_webhook_event_request = cobo_waas2.TriggerTestWebhookEventRequest(
        event_type="wallets.transaction.created"
    )

    try:
        # Trigger test event
        api_response = api_instance.trigger_test_webhook_event(
            trigger_test_webhook_event_request=trigger_test_webhook_event_request
        )
        print("The response of DevelopersWebhooksApi->trigger_test_webhook_event:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling DevelopersWebhooksApi->trigger_test_webhook_event: %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.

Body

application/json

The request body used to trigger a test webhook event.

​
event_type
enum<string>
required

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.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.transaction.failed,
payment.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,
compliance.disposition.status.updated,
compliance.kyt.screenings.status.updated,
compliance.kya.screenings.status.updated
Example:

"wallets.transaction.created"

​
override_data
object

An object for customization of the webhook event payload. You only need to include the fields you want to customize.

The provided fields must match the webhook event data structure, depending on the specified event type. For a complete introduction of the webhook event data structure, refer to the data.data property in the response of List all webhook events.

If this property is not provided, a default payload will be returned.

Example:
{
  "chain_id": "ETH",
  "transaction_id": "Test-transaction-id"
}

Response

The request was successful.

​
triggered
boolean

Whether a test webhook event was successfully triggered.

  • true: The test webhook event was successfully triggered.
  • false: The test webhook event could not be triggered.
Example:

true