How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Azure Web PubSub

Azure Web PubSub Hub API

Send messages and manage connections, groups, and users in a hub

Documentation Provider Profile APIs.io OpenAPI GitHub

Azure Web PubSub Hub API is one of 8 APIs that Azure Web PubSub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Hub. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 15 operations across 12 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 2024-01-01.

Requests are made against a single base URL, https://{instance}.webpubsub.azure.com.

15 operations 12 paths 1 schemas 3 DELETE3 HEAD7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2024-01-01
Base URL
https://{instance}.webpubsub.azure.com
Authentication
HTTP Bearer
Contact
Kin Lane
License
Microsoft Terms of Use
Resource Areas
1

Authentication & Security 1

Azure Web PubSub Hub API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth). By default, every request must be authenticated.

  • bearer_auth — JWT signed with the service AccessKey using HS256, or a Microsoft Entra ID OAuth 2.0 bearer token with scope https://webpubsub.azure.com/.default

Paths & Operations 15

Across 12 paths, the API surfaces 15 operations — 3 DELETE, 3 HEAD, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Hub 15

Send messages and manage connections, groups, and users in a hub

POST
/api/hubs/{hub}/:send
Broadcast a message to all connections in the hub
webPubSub_sendToAll 5 params body → 202default
POST
/api/hubs/{hub}/connections/{connectionId}/:send
Send message to a specific connection
webPubSub_sendToConnection 3 params body → 202
POST
/api/hubs/{hub}/groups/{group}/:send
Send message to a group of connections
webPubSub_sendToGroup 4 params body → 202
POST
/api/hubs/{hub}/users/{userId}/:send
Send message to a specific user
webPubSub_sendToUser 3 params body → 202
HEAD
/api/hubs/{hub}/connections/{connectionId}
Check if a connection exists
webPubSub_connectionExists 3 params → 200404
DELETE
/api/hubs/{hub}/connections/{connectionId}
Close a connection
webPubSub_closeConnection 4 params → 204
POST
/api/hubs/{hub}/:closeConnections
Close all connections in the hub
webPubSub_closeAllConnections 4 params → 204
POST
/api/hubs/{hub}/groups/{group}/:close
Close connections in a group
webPubSub_closeGroupConnections 3 params → 204
POST
/api/hubs/{hub}/users/{userId}/:close
Close connections for a user
webPubSub_closeUserConnections 3 params → 204
HEAD
/api/hubs/{hub}/groups/{group}
Check if a group has any connections
webPubSub_groupExists 3 params → 200404
HEAD
/api/hubs/{hub}/users/{userId}
Check if a user has any connections
webPubSub_userExists 3 params → 200404
PUT
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
Add a connection to a group
webPubSub_addConnectionToGroup 4 params → 200
DELETE
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
Remove a connection from a group
webPubSub_removeConnectionFromGroup 4 params → 204
PUT
/api/hubs/{hub}/groups/{group}/users/{userId}
Add a user to a group
webPubSub_addUserToGroup 4 params → 200
DELETE
/api/hubs/{hub}/groups/{group}/users/{userId}
Remove a user from a group
webPubSub_removeUserFromGroup 4 params → 204

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ErrorDetail (4 properties). Each schema is shown below with its type and property counts.

ErrorDetail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-web-pubsub-hub-api-openapi.yml Raw ↑

Other APIs Azure Web PubSub publishes across the network.

Azure Web PubSub Client and Upstream Events
AE Profile APIs.io
Azure Web PubSub Hubs REST API
AE Profile APIs.io
Azure Web PubSub for Socket.IO REST API
AE Profile APIs.io
Azure Web PubSub Private Endpoint Connections REST API
AE Profile APIs.io
Azure Web PubSub Shared Private Link Resources REST API
AE Profile APIs.io
Azure Web PubSub ClientToken API
AE Profile APIs.io
Azure Web PubSub Permission API
AE Profile APIs.io
#Hub
← Back to A APIs
API Details
ID
microsoft-azure-web-pubsub:microsoft-azure-web-pubsub-hub-api
Base URL
https://{instance}.webpubsub.azure.com
Docs
https://learn.microsoft.com/en-us/rest/api/webpubsub/dataplane
Provider
Azure Web PubSub
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=microsoft-azure-web-pubsub-hub-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/microsoft-azure-web-pubsub-hub-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Azure Web PubSub Hub API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.