Skip to main content
PUT
/
webhooks
/
endpoints
/
{endpoint_id}
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
        )


{
  "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"
}
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
        )

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.

Path Parameters

​
endpoint_id
string<uuid>
required

The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling List webhook endpoints.

Body

application/json

The request body to update a webhook endpoint.

​
subscribed_events
enum<string>[]

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.

​
status
enum<string>

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.

Available options:
STATUS_INACTIVE
Example:

"STATUS_INACTIVE"

​
description
string

The webhook endpoint description.

Example:

"My webhook endpoint"

Response

Update webhook endpoint successfully.

The information about a webhook endpoint.

​
url
string<url>
required

The webhook endpoint URL.

Maximum length: 500
Example:

"https://example.com/webhook"

​
subscribed_events
enum<string>[]
required

The event types subscribed by a webhook endpoint.

​
created_timestamp
integer
required

The time when the endpoint was registered, in Unix timestamp format, measured in seconds.

Example:

1701396866000

​
status
enum<string>
required

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"

​
endpoint_id
string<uuid>

The webhook endpoint ID.

Example:

"8f2e919a-6a7b-4a9b-8c1a-4c0b3f5b8b1f"

​
description
string

The description of the webhook endpoint.

Example:

"My webhook endpoint"