> For the complete documentation index, see [llms.txt](https://docs.mosip.io/1.2.0/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mosip.io/1.2.0/id-lifecycle-management/supporting-services/websub.md).

# WebSub

## Overview

WebSub provides a common mechanism for communication between publishers of any kind of Web content and their subscribers, based on HTTP web hooks. Subscription requests are relayed through hubs, which validate and verify the request. Hubs then distribute new and updated content to subscribers when it becomes available. WebSub was previously known as PubSubHubbub. For more information, read [W3C WebSub](https://www.w3.org/TR/websub/).

## WebSub in MOSIP

In MOSIP, WebSub is used to share data with services and partners. [Kafka](https://kafka.apache.org/) message broker has been used to implement the WebSub APIs. Message brokers are a natural fit for the implementation of WebSub hubs as they serve a similar purpose.

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-00ecbeeb063a2d0d9dd099027ab5774d5a1256e2%2Fwebsub.png?alt=media\&token=e422adb8-352c-47b9-8ff2-2bdc484ffb57)

The relationship of WebSub with other services is explained here. *NOTE: The numbers do not signify sequence of operations or control flow.*

1. Topic is registered and published or subscribed by MOSIP Services.
2. Content delivery and Intent Verification is done by WebSub to Mosip Services.
3. Content delivery and Intent Verification is done by WebSub to Partners.
4. Topic is registered and published or subscribed by the Partners.
5. Data and metadata needed for delivery, delivery reports and other functionalities are stored in Kafka.

Refer [WebSub repo](https://github.com/mosip/websub/tree/release-1.2.0) for further details.

## Developer Guide

To know more about the developer setup, read [WebSub Developers Guide](https://docs.mosip.io/1.2.0/modules/websub/websub-developer-guide).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.mosip.io/1.2.0/id-lifecycle-management/supporting-services/websub.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
