get<\/code><\/td>\/subscriptions<\/code><\/td>Paginated overview; requires use mod_websub<\/code>. Payload: type<\/code> (all<\/code>, export<\/code>, import<\/code>), numeric local rsc_id<\/code>, hostname<\/code>, status<\/code>, errors<\/code> (yes<\/code>\/no<\/code>\/all<\/code>), and page<\/code>.<\/td><\/tr>get<\/code><\/td>\/subscriber_count\/+id<\/code><\/td>| Number of unexpired incoming subscriptions; requires resource edit permission.<\/td><\/tr> | get<\/code><\/td>\/status\/+id<\/code><\/td>Latest import subscription status for an editable resource, or undefined<\/code> when none exists.<\/td><\/tr><\/tbody><\/table>\n+id<\/code> is resolved through m_rsc:rid\/2<\/code>. The template equivalent is\nm.websub.status[id]<\/code>; the model checks resource edit permission independently of\nthe template or controller. Unauthorized reads return eacces<\/code>. There are no\npublic model POST or DELETE paths for starting or stopping subscriptions.<\/p>\nThe overview includes retained expired\/stopped subscriptions and renewal generations,\n50 rows per page. Hostname is an exact, case-insensitive match on the incoming\ncallback host or outgoing source host, ignoring ports and a trailing DNS dot.\nStatus accepts active<\/code>, pending<\/code>, expired<\/code>, or stopped<\/code>; empty\/all<\/code> means all\nstates. The errors filter selects rows with or without the table’s error indicator.\nAll filters apply before pagination and counting. The overview returns a\nsearch_result<\/code> record with an exact total, capped at 10,000 pages.\nIt returns remote hostnames, never callback URLs, tokens, secrets,\nor authentication data. Invalid filters return is_invalid<\/code> without broadening the query.<\/p>\nStatus includes desired state (is_enabled<\/code>), confirmation state\n(is_unsubscribed<\/code>, is_active<\/code>), pending_mode<\/code>, lease<\/code>, last_received<\/code>,\nlast_error<\/code>, and credential_error<\/code>. During renewal, is_active<\/code> also accounts\nfor a still-active predecessor callback. Status never exposes callback tokens,\nHMAC secrets, or source OAuth2 tokens.<\/p>\nErlang API<\/h2>\nsubscribe\/2<\/code> starts a durable subscription for an editable, non-authoritative\nresource with a remote URI. It requires a logged-in user and is idempotent for\nan already-enabled subscription to that source. Discovery and verification run\nasynchronously; ok<\/code> means intent was recorded, not that the hub confirmed it.<\/li>unsubscribe\/2<\/code> requires edit permission, immediately disables automatic imports,\ndiscards queued updates, and schedules remote unsubscription.<\/li>topic_url\/2<\/code> generates the language-independent JSON topic URL. Use\nm_rsc:uri\/2<\/code> for the resource's semantic \/id<\/code> identity instead.<\/li><\/ul>\nok = m_websub:subscribe(Id, Context).\nok = m_websub:unsubscribe(Id, Context).\n<\/code><\/pre>\nAdmin postbacks call these checked functions. The remaining exported queue,\nverification, export-registration, schema, and maintenance functions are internal\nintegration APIs. They are not exposed through model paths. In particular,\nupdate_export\/6<\/code> and delete_export\/3<\/code> are called after the hub has verified intent;\ncallers must not use them to bypass authorization or callback verification.<\/p>\nDelivery and import processing<\/h2>\nPublisher queues coalesce resource versions, enforce lease expiry, and recheck\ncurrent access within the original authentication's group restrictions. Delivery\ncontains the complete JSON topic representation and a signature when a secret was\nsupplied. Exhausted retries discard that notification, allowing later updates to\nretry delivery for the remaining lease.<\/p>\n Subscriber callbacks identify the subscription by capability token and validate\nthe signed resource URI. Public imports consume the pushed JSON; credentialed\nimports refetch through z_fetch<\/code> using the subscribing user's source credentials.\nBefore applying content, the import transaction checks current edit permission,\nnon-authoritative status, source identity, and version ordering. Saved import\noptions are reused without allowing automatic updates to restart a stopped\nsubscription. Resource identity is stored separately from the discovered WebSub\ntopic_url<\/code>, so topic migration does not change the semantic resource identifier.<\/p>\nSee mod_websub<\/code> for the two-site protocol flow and z_websub_subscription<\/code> for\nrenewal, pending intent, callback rotation, and subscriber state persistence.<\/p>","slug":"websub","is_protected":false,"visible_for":0,"tz":"UTC","language":["en"],"doc_source_hash":"af334f4f1958aed9fd1a24417229ddd9a5ee6aac6c5c8bb95fea4fbd04ec059e","is_featured":false,"content_group_id":{"id":2551,"is_a":["meta","content_group"],"name":"content_group_imported_docs","title":"Imported documentation","uri":"https:\/\/zotonic.com\/id\/content_group_imported_docs"},"category_id":{"id":322,"is_a":["meta","category"],"name":"model","title":"Models","uri":"https:\/\/test.zotonic.com\/id\/322"},"doc_source_path":"apps\/zotonic_mod_websub\/src\/models\/m_websub.erl","publication_start":"2026-09-29T13:07:54Z","github_url":"https:\/\/github.com\/zotonic\/zotonic\/blob\/master\/apps\/zotonic_mod_websub\/src\/models\/m_websub.erl","pivot_location_lng":null,"doc_source_kind":"model","name":"doc_model_model_websub","is_unfindable":false,"is_published":true,"pivot_geocode":null,"created":"2026-09-29T13:07:54Z","uri":null,"doc_status":"current","is_dependent":false,"erlang_app":"zotonic_mod_websub","publication_end":"9999-06-01T00:00:00Z","modifier_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"privacy":0,"doc_source_commit":"85498256abd162b9bc082d43a90c995844fd4408\n","erlang_module":"m_websub","creator_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"modified":"2026-09-29T14:40:25Z","title_slug":"websub"},"uri":"https:\/\/zotonic.com\/id\/2712","uri_template":"https:\/\/zotonic.com\/id\/:id","websub":{"hub":"https:\/\/zotonic.com\/.zotonic\/websub","topic":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/2712"}},"status":"ok"}
| | | | | | | |