import cobo_waas2
from cobo_waas2.models.update_webhook_endpoint_by_id_request import (
UpdateWebhookEndpointByIdRequest,
)
from cobo_waas2.models.webhook_endpoint import WebhookEndpoint
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)
endpoint_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
update_webhook_endpoint_by_id_request = (
cobo_waas2.UpdateWebhookEndpointByIdRequest()
)
try:
# Update webhook endpoint
api_response = api_instance.update_webhook_endpoint_by_id(
endpoint_id,
update_webhook_endpoint_by_id_request=update_webhook_endpoint_by_id_request,
)
print("The response of DevelopersWebhooksApi->update_webhook_endpoint_by_id:\n")
pprint(api_response)
except Exception as e:
print(
"Exception when calling DevelopersWebhooksApi->update_webhook_endpoint_by_id: %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();
UUID endpointId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
UpdateWebhookEndpointByIdRequest updateWebhookEndpointByIdRequest =
new UpdateWebhookEndpointByIdRequest();
try {
WebhookEndpoint result =
apiInstance.updateWebhookEndpointById(endpointId, updateWebhookEndpointByIdRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DevelopersWebhooksApi#updateWebhookEndpointById");
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() {
endpointId := "f47ac10b-58cc-4372-a567-0e02b2c3d479"
updateWebhookEndpointByIdRequest := *coboWaas2.NewUpdateWebhookEndpointByIdRequest()
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.UpdateWebhookEndpointById(ctx, endpointId).
UpdateWebhookEndpointByIdRequest(updateWebhookEndpointByIdRequest).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `DevelopersWebhooksAPI.UpdateWebhookEndpointById``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateWebhookEndpointById`: WebhookEndpoint
fmt.Fprintf(
os.Stdout,
"Response from `DevelopersWebhooksAPI.UpdateWebhookEndpointById`: %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 endpoint_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const opts = {
UpdateWebhookEndpointByIdRequest:
new CoboWaas2.UpdateWebhookEndpointByIdRequest(),
};
apiInstance.updateWebhookEndpointById(endpoint_id, opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"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"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Update webhook endpoint
This operation updates the information of a specified webhook endpoint.
import cobo_waas2
from cobo_waas2.models.update_webhook_endpoint_by_id_request import (
UpdateWebhookEndpointByIdRequest,
)
from cobo_waas2.models.webhook_endpoint import WebhookEndpoint
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)
endpoint_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
update_webhook_endpoint_by_id_request = (
cobo_waas2.UpdateWebhookEndpointByIdRequest()
)
try:
# Update webhook endpoint
api_response = api_instance.update_webhook_endpoint_by_id(
endpoint_id,
update_webhook_endpoint_by_id_request=update_webhook_endpoint_by_id_request,
)
print("The response of DevelopersWebhooksApi->update_webhook_endpoint_by_id:\n")
pprint(api_response)
except Exception as e:
print(
"Exception when calling DevelopersWebhooksApi->update_webhook_endpoint_by_id: %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();
UUID endpointId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
UpdateWebhookEndpointByIdRequest updateWebhookEndpointByIdRequest =
new UpdateWebhookEndpointByIdRequest();
try {
WebhookEndpoint result =
apiInstance.updateWebhookEndpointById(endpointId, updateWebhookEndpointByIdRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DevelopersWebhooksApi#updateWebhookEndpointById");
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() {
endpointId := "f47ac10b-58cc-4372-a567-0e02b2c3d479"
updateWebhookEndpointByIdRequest := *coboWaas2.NewUpdateWebhookEndpointByIdRequest()
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.UpdateWebhookEndpointById(ctx, endpointId).
UpdateWebhookEndpointByIdRequest(updateWebhookEndpointByIdRequest).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `DevelopersWebhooksAPI.UpdateWebhookEndpointById``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateWebhookEndpointById`: WebhookEndpoint
fmt.Fprintf(
os.Stdout,
"Response from `DevelopersWebhooksAPI.UpdateWebhookEndpointById`: %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 endpoint_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const opts = {
UpdateWebhookEndpointByIdRequest:
new CoboWaas2.UpdateWebhookEndpointByIdRequest(),
};
apiInstance.updateWebhookEndpointById(endpoint_id, opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"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"
}{
"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.update_webhook_endpoint_by_id_request import (
UpdateWebhookEndpointByIdRequest,
)
from cobo_waas2.models.webhook_endpoint import WebhookEndpoint
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)
endpoint_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
update_webhook_endpoint_by_id_request = (
cobo_waas2.UpdateWebhookEndpointByIdRequest()
)
try:
# Update webhook endpoint
api_response = api_instance.update_webhook_endpoint_by_id(
endpoint_id,
update_webhook_endpoint_by_id_request=update_webhook_endpoint_by_id_request,
)
print("The response of DevelopersWebhooksApi->update_webhook_endpoint_by_id:\n")
pprint(api_response)
except Exception as e:
print(
"Exception when calling DevelopersWebhooksApi->update_webhook_endpoint_by_id: %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();
UUID endpointId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
UpdateWebhookEndpointByIdRequest updateWebhookEndpointByIdRequest =
new UpdateWebhookEndpointByIdRequest();
try {
WebhookEndpoint result =
apiInstance.updateWebhookEndpointById(endpointId, updateWebhookEndpointByIdRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DevelopersWebhooksApi#updateWebhookEndpointById");
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() {
endpointId := "f47ac10b-58cc-4372-a567-0e02b2c3d479"
updateWebhookEndpointByIdRequest := *coboWaas2.NewUpdateWebhookEndpointByIdRequest()
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.UpdateWebhookEndpointById(ctx, endpointId).
UpdateWebhookEndpointByIdRequest(updateWebhookEndpointByIdRequest).
Execute()
if err != nil {
fmt.Fprintf(
os.Stderr,
"Error when calling `DevelopersWebhooksAPI.UpdateWebhookEndpointById``: %v\n",
err,
)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateWebhookEndpointById`: WebhookEndpoint
fmt.Fprintf(
os.Stdout,
"Response from `DevelopersWebhooksAPI.UpdateWebhookEndpointById`: %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 endpoint_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const opts = {
UpdateWebhookEndpointByIdRequest:
new CoboWaas2.UpdateWebhookEndpointByIdRequest(),
};
apiInstance.updateWebhookEndpointById(endpoint_id, 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.
Path Parameters
The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling List webhook endpoints.
Body
The request body to update a webhook endpoint.
The new event types you want to subscribe to for this webhook endpoint. You can call Get webhook event types to retrieve all available event types.
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 The new status you want to set the webhook endpoint to. If you set status to STATUS_INACTIVE, the endpoint will be revoked, meaning it will no longer receive any webhook events.
STATUS_INACTIVE "STATUS_INACTIVE"
The webhook endpoint description.
"My webhook endpoint"
Response
Update webhook endpoint successfully.
The information about a webhook endpoint.
The webhook endpoint URL.
500"https://example.com/webhook"
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.
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 The time when the endpoint was registered, in Unix timestamp format, measured in seconds.
1701396866000
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 webhook endpoint ID.
"8f2e919a-6a7b-4a9b-8c1a-4c0b3f5b8b1f"
The description of the webhook endpoint.
"My webhook endpoint"
Was this page helpful?
