Skip to main content
PATCH
Update Webhook Subscription

Path Parameters

portfolio_id
string
required
subscription_id
string
required

Body

application/json

UpdateWebhookSubscriptionRequest specifies a partial subscription update using a field mask.

event_types
string[]
target_url
string
auth_type
enum<string>

WebhookAuthType identifies the authentication method used to deliver webhook events.

Available options:
WEBHOOK_AUTH_TYPE_HMAC,
WEBHOOK_AUTH_TYPE_OAUTH,
WEBHOOK_AUTH_TYPE_MTLS,
WEBHOOK_AUTH_TYPE_OAUTH_MTLS
oauth_config
object

WebhookOAuthConfigInput supplies OAuth credentials and scopes for a subscription.

custom_headers
object
description
string
is_enabled
boolean
update_mask
string
expected_version
string<int64>

Response

A successful response.

UpdateWebhookSubscriptionResponse returns the updated subscription without authentication secrets.

subscription
object

WebhookSubscription is the customer-facing representation of a webhook subscription. auth secrets (hmac_secret, oauth client_secret) are never included; hmac_secret is returned exactly once in CreateWebhookSubscriptionResponse.