Update a webhook subscription
Update a webhook subscription. Metadata fields can be updated independently. To update filters, provide notificationTypes, addresses, and domains together; those fields fully replace the existing filters.
Authorizations
Headers
Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. Must be a UUID to appear in logs. Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
A unique identifier, which can be helpful for identifying a request when communicating with Circle support.
"2adba88e-9d63-44bc-b975-9b6ae3440dde"
Path Parameters
Body
Schema for the request payload to update a subscription.
Fields to update on a subscription. Metadata fields can be updated independently. To update filters, provide notificationTypes, addresses, and domains together; those fields fully replace the existing filters when provided.
The notification types to subscribe to. Must be provided together with addresses and domains when changing filters. Fully replaces the existing list on update.
Notification type for Gateway webhook subscriptions. Omit notificationTypes or use
gateway.* to subscribe to all current and future Gateway notification types. Use individual
event types to restrict delivery to specific Gateway events.
gateway.*, gateway.deposit.finalized, gateway.mint.finalized, gateway.mint.forwarded