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
)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.DevelopersWebhooksApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
DevelopersWebhooksApi apiInstance = new DevelopersWebhooksApi();
WebhookEndpointStatus status = WebhookEndpointStatus.fromValue("STATUS_ACTIVE");
WebhookEventType eventType = WebhookEventType.fromValue("wallets.transaction.created");
Integer limit = 10;
String before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1";
String after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk";
try {
ListWebhookEndpoints200Response result =
apiInstance.listWebhookEndpoints(status, eventType, limit, before, after);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DevelopersWebhooksApi#listWebhookEndpoints");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
status := coboWaas2.WebhookEndpointStatus("STATUS_ACTIVE")
eventType := coboWaas2.WebhookEventType("wallets.transaction.created")
limit := int32(10)
before := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
after := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.DevelopersWebhooksAPI.ListWebhookEndpoints(ctx).
Status(status).
EventType(eventType).
Limit(limit).
Before(before).
After(after).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `DevelopersWebhooksAPI.ListWebhookEndpoints``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListWebhookEndpoints`: ListWebhookEndpoints200Response
fmt.Fprintf(os.Stdout, "Response from `DevelopersWebhooksAPI.ListWebhookEndpoints`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.DevelopersWebhooksApi();
const opts = {
status: new CoboWaas2.WebhookEndpointStatus(),
event_type: new CoboWaas2.WebhookEventType(),
limit: 10,
before: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
after: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
};
apiInstance.listWebhookEndpoints(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"data": [
{
"url": "https://example.com/webhook",
"subscribed_events": [
"wallets.transaction.created"
],
"created_timestamp": 1701396866000,
"status": "STATUS_ACTIVE",
"endpoint_id": "8f2e919a-6a7b-4a9b-8c1a-4c0b3f5b8b1f",
"description": "My webhook endpoint"
}
],
"pagination": {
"before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
"after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
"total_count": 10000
}
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}List webhook endpoints
This operation retrieves the information of all webhook endpoints registered under your organization. You can filter the result by endpoint status and the subscribed event type.
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
)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.DevelopersWebhooksApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
DevelopersWebhooksApi apiInstance = new DevelopersWebhooksApi();
WebhookEndpointStatus status = WebhookEndpointStatus.fromValue("STATUS_ACTIVE");
WebhookEventType eventType = WebhookEventType.fromValue("wallets.transaction.created");
Integer limit = 10;
String before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1";
String after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk";
try {
ListWebhookEndpoints200Response result =
apiInstance.listWebhookEndpoints(status, eventType, limit, before, after);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DevelopersWebhooksApi#listWebhookEndpoints");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
status := coboWaas2.WebhookEndpointStatus("STATUS_ACTIVE")
eventType := coboWaas2.WebhookEventType("wallets.transaction.created")
limit := int32(10)
before := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
after := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.DevelopersWebhooksAPI.ListWebhookEndpoints(ctx).
Status(status).
EventType(eventType).
Limit(limit).
Before(before).
After(after).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `DevelopersWebhooksAPI.ListWebhookEndpoints``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListWebhookEndpoints`: ListWebhookEndpoints200Response
fmt.Fprintf(os.Stdout, "Response from `DevelopersWebhooksAPI.ListWebhookEndpoints`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.DevelopersWebhooksApi();
const opts = {
status: new CoboWaas2.WebhookEndpointStatus(),
event_type: new CoboWaas2.WebhookEventType(),
limit: 10,
before: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
after: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
};
apiInstance.listWebhookEndpoints(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"data": [
{
"url": "https://example.com/webhook",
"subscribed_events": [
"wallets.transaction.created"
],
"created_timestamp": 1701396866000,
"status": "STATUS_ACTIVE",
"endpoint_id": "8f2e919a-6a7b-4a9b-8c1a-4c0b3f5b8b1f",
"description": "My webhook endpoint"
}
],
"pagination": {
"before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
"after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
"total_count": 10000
}
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}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
)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.DevelopersWebhooksApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
DevelopersWebhooksApi apiInstance = new DevelopersWebhooksApi();
WebhookEndpointStatus status = WebhookEndpointStatus.fromValue("STATUS_ACTIVE");
WebhookEventType eventType = WebhookEventType.fromValue("wallets.transaction.created");
Integer limit = 10;
String before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1";
String after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk";
try {
ListWebhookEndpoints200Response result =
apiInstance.listWebhookEndpoints(status, eventType, limit, before, after);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DevelopersWebhooksApi#listWebhookEndpoints");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
status := coboWaas2.WebhookEndpointStatus("STATUS_ACTIVE")
eventType := coboWaas2.WebhookEventType("wallets.transaction.created")
limit := int32(10)
before := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
after := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.DevelopersWebhooksAPI.ListWebhookEndpoints(ctx).
Status(status).
EventType(eventType).
Limit(limit).
Before(before).
After(after).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `DevelopersWebhooksAPI.ListWebhookEndpoints``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListWebhookEndpoints`: ListWebhookEndpoints200Response
fmt.Fprintf(os.Stdout, "Response from `DevelopersWebhooksAPI.ListWebhookEndpoints`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.DevelopersWebhooksApi();
const opts = {
status: new CoboWaas2.WebhookEndpointStatus(),
event_type: new CoboWaas2.WebhookEventType(),
limit: 10,
before: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
after: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
};
apiInstance.listWebhookEndpoints(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
Authorizations
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
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.
STATUS_ACTIVE, STATUS_INACTIVE, STATUS_PENDING_ACTIVE, STATUS_PENDING_INACTIVE, STATUS_PENDING_UPDATE, STATUS_REJECT_ACTIVE "STATUS_ACTIVE"
The event type. To learn the trigger condition of each event type, refer to Webhook event types and event data.
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.bulk_send.item.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 "wallets.transaction.created"
The maximum number of objects to return. For most operations, the value range is [1, 50].
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.
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.
Was this page helpful?
