AsyncAPI channel · Circle
· Circle Webhook Notifications
/circle/gateway
Subscriber endpoint that receives Circle Gateway permissionless
notifications. Subscribers can filter by `notificationTypes`,
`addresses` and `domains` on the subscription resource. Use
`gateway.*` to subscribe to all current and future Gateway notification
types.
Provider:CircleAsyncAPI: v2.6.0Spec: Circle Webhook NotificationsOperations: 1Messages: 3
Channel address
/circle/gateway
Operations
publish
receiveGatewayNotification
Receive a Gateway webhook notification
Messages
GatewayDepositFinalized
A Gateway deposit has been finalized on the source chain.
Content-Type: application/json
GatewayMintFinalized
A Gateway mint has been finalized on the destination chain.
Content-Type: application/json
GatewayMintForwarded
A Gateway mint has been forwarded between domains.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.