Overview

Patchwork Hooks are small bits of code which enable any Fediverse app to work with a Patchwork enhanced server and / or Patchwork Channels.

Hooks are for those parts of Patchwork which need changes in the User Interface (UI) to work, for example enabling long posts, displaying federation choices on the server’s home page or accessing Channels.

Hooks can help app developers improve the experience of their users by enabling them to get the full range features offered by a Patchwork enhanced server.

Sign on hook

When an app user signs into a Patchwork enhanced server, as part of the authorisation process the hook helps the server tell the app: The user is on a Patchwork enhanced server. Which features are enabled. Provides any code necessary to make the features work.

Channel hook

The Channel hook makes it possible for users on any app and any server to browse, select and post to any Channel.

Basic level Enabling apps to browse and engage with content on other servers without having to sign in.

Enhanced level Introduces Channels fully and allows users to:

• Discover - Browse Channels in app
• Link - Users can link to channels in posts
• Post - Posts are automatically directed to selected Channels using unique hashtags or emojis.

Upgrade hook

We are also looking into ways to automatically communicate when servers are upgraded and when changes are made (eg. features enabled). The aim is to make this process as simple and unobtrusive for app developers as possible while enabling the full suite of features for users.

Apps that support Patchwork

We will update this section with a list of apps that support Patchwork.