Skip to main content
GET
/
webhooks
/
endpoints
import cobo_waas2
from cobo_waas2.models.list_webhook_endpoints200_response import (
    ListWebhookEndpoints200Response,
)
from cobo_waas2.models.webhook_endpoint_status import WebhookEndpointStatus
from cobo_waas2.models.webhook_event_type import WebhookEventType
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)
    status = cobo_waas2.WebhookEndpointStatus()
    event_type = cobo_waas2.WebhookEventType()
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"

    try:
        # List webhook endpoints
        api_response = api_instance.list_webhook_endpoints(
            status=status,
            event_type=event_type,
            limit=limit,
            before=before,
            after=after,
        )
        print("The response of DevelopersWebhooksApi->list_webhook_endpoints:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling DevelopersWebhooksApi->list_webhook_endpoints: %s\n"
            % e
        )


{
  "data": [
    {
      "url": "https://example.com/webhook",
      "subscribed_events": [
        "wallets.transaction.created"
      ],
      "created_timestamp": 1701396866000,
      "endpoint_id": "8f2e919a-6a7b-4a9b-8c1a-4c0b3f5b8b1f",
      "status": "STATUS_ACTIVE",
      "description": "My webhook endpoint"
    }
  ],
  "pagination": {
    "before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
    "after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
    "total_count": 10000
  }
}
import cobo_waas2
from cobo_waas2.models.list_webhook_endpoints200_response import (
    ListWebhookEndpoints200Response,
)
from cobo_waas2.models.webhook_endpoint_status import WebhookEndpointStatus
from cobo_waas2.models.webhook_event_type import WebhookEventType
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)
    status = cobo_waas2.WebhookEndpointStatus()
    event_type = cobo_waas2.WebhookEventType()
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"

    try:
        # List webhook endpoints
        api_response = api_instance.list_webhook_endpoints(
            status=status,
            event_type=event_type,
            limit=limit,
            before=before,
            after=after,
        )
        print("The response of DevelopersWebhooksApi->list_webhook_endpoints:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling DevelopersWebhooksApi->list_webhook_endpoints: %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.

Query Parameters

​
status
enum<string>

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"

​
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"

​
limit
integer
default:10

The maximum number of objects to return. For most operations, the value range is [1, 50].

​
before
string

A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.

​
after
string

A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.

Response

Successfully listed of webhook endpoints

​
data
object[]
​
pagination
object

The pagination information of the returned data.