# Azure Web PubSub Client and Upstream Events

**Canonical:** https://apis.io/apis/microsoft-azure-web-pubsub/azure-web-pubsub-client-and-upstream-events/  
**Provider:** Azure Web PubSub — https://apis.io/providers/microsoft-azure-web-pubsub/  
**Base URL:** wss://{instance}.webpubsub.azure.com  
**Documentation:** https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-json-webpubsub-subprotocol

Azure Web PubSub Client and Upstream Events is one of 8 APIs that [Azure Web PubSub](https://apis.io/providers/microsoft-azure-web-pubsub/) publishes on the [APIs.io](https://apis.io/) network, described by an AsyncAPI event-driven specification. Tagged areas include AsyncAPI, CloudEvents, Event-Driven, Pub-Sub, and WebSockets. The published artifact set on APIs.io includes an AsyncAPI specification, API documentation, an API reference, and authentication docs.

AsyncAPI 2.6 description of the Azure Web PubSub client WebSocket subprotocols (json.webpubsub.azure.v1 and json.reliable.webpubsub.azure.v1) and the CloudEvents 1.0 HTTP upstream contract used by the service to deliver client events (connect, connected, disconnected, message, user custom events) to a configured backend webhook.

## Machine-readable artifacts (18)

- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/main/asyncapi/microsoft-azure-web-pubsub-asyncapi.yml
- **Documentation** — https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-json-webpubsub-subprotocol
- **Reference** — https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-json-reliable-webpubsub-subprotocol
- **Reference** — https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-cloud-events
- **Authentication** — https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-generate-client-tokens
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/apis.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-check-then-close-connection-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-direct-connection-message-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-grant-permission-and-send-to-user-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-grant-permission-if-missing-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-group-broadcast-if-active-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-group-warn-and-teardown-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-join-group-and-send-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-notify-user-if-online-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-provision-client-and-join-group-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-revoke-permission-and-evict-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-token-then-broadcast-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-web-pubsub/refs/heads/main/arazzo/microsoft-azure-web-pubsub-user-onboard-to-group-workflow.yml

## Other Azure Web PubSub APIs (7)

- [Azure Web PubSub Hubs REST API](https://apis.io/apis/microsoft-azure-web-pubsub/azure-web-pubsub-hubs-rest-api/)
- [Azure Web PubSub for Socket.IO REST API](https://apis.io/apis/microsoft-azure-web-pubsub/azure-web-pubsub-for-socketio-rest-api/)
- [Azure Web PubSub Private Endpoint Connections REST API](https://apis.io/apis/microsoft-azure-web-pubsub/azure-web-pubsub-private-endpoint-connections-rest-api/)
- [Azure Web PubSub Shared Private Link Resources REST API](https://apis.io/apis/microsoft-azure-web-pubsub/azure-web-pubsub-shared-private-link-resources-rest-api/)
- [Azure Web PubSub ClientToken API](https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-clienttoken-api/)
- [Azure Web PubSub Hub API](https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-hub-api/)
- [Azure Web PubSub Permission API](https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-permission-api/)

## Tags

AsyncAPI, CloudEvents, Event-Driven, Pub-Sub, WebSockets

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/microsoft-azure-web-pubsub/azure-web-pubsub-client-and-upstream-events/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/microsoft-azure-web-pubsub/.