Skip to content
This repository has been archived by the owner on Nov 17, 2021. It is now read-only.
/ tratschtante Public archive

This plugin is deprecated, please use the indieConnector plugin which is compatible.

License

Notifications You must be signed in to change notification settings

mauricerenck/tratschtante

Repository files navigation

Kirby Tratschtante

DEPRECATED


THIS PLUGIN WILL BE DISCONTINUED! With the launch of Kirby 3.6 this plugin won't receive updates. Please switch to IndieConnector which comes with the same base functionality and which is 100% compatible with this plugin.


GitHub release License Kirby Version


This plugin currently works only with webmention.io.

Add the Tratschtante Endpoint to your webmention.io Webhooks and enter the callback secret you set in your kirby config.

Installation

  • composer require mauricerenck/tratschtante
  • unzip master.zip to site/plugins/tratschtante
  • git submodule add https://github.com/mauricerenck/tratschtante.git site/plugins/tratschtante

Config

You have to set a callback secret in your config.php

[
    'mauricerenck.tratschtante.secret' => 'my-secret',
]
  • Go to your webemention.io account and to Webhooks.
  • Enter the Tratschtante endpoint: https://your-url.tld/tratschtante/webhook/webmentionio
  • Enter the callback secret you set in your config.php

Usage

Whenever a webmention ins received, Tratschtante will trigger a Kirby-Hook your plugin can subscribe to:

'hooks' => [
    'tratschtante.webhook.received' => function ($webmention, $targetPage) {
        // $webmention: webmention data, see below
        // $targetPage: a kirby page object

        // YOUR CODE
    }
],

Data

Tratschtante will handle an array with some data to you:

[
'type' => STRING // one of the webmention.io types, see https://webmention.io/settings/webhooks,
'target' => 'target url',
'source' => 'source url',
'published' => 'publication date',
'author' => [
    'type' => 'card' or null,
    'name' => 'name' or null,
    'avatar' => 'avatar-url' or null,
    'url' => 'author url' or null,
],
'content' => 'comment text or empty string'
]

Future Plans

  • Sending webmentions (already implemented elsewhere, just have to move it here)
  • Support for "native" webmentions, not only webmention.io