Create a webhook subscription
Create a permissionless webhook subscription by configuring an endpoint to receive event notifications. Specify the environment, wallet addresses to monitor, blockchain domains to watch, and event types to receive.
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"
Body
Schema for the request payload to create a new subscription.
Required parameters to create a new subscription.
The notification types to subscribe to. If omitted or if gateway.* is provided, the webhook is unrestricted for Gateway events and the response returns restricted: false. If individual event types are provided, the webhook is restricted to those event types.
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