User Tools

Site Tools


extension:poke

Poke (not final)

The Poke extension allows an actor to send a generic notification to another, to get a user's attention.

On the actor:

"extensions": {
    "https://pawpub.entities.org.uk/extension/poke": "https://social.example/actor/1/poke",
    ...
}

Another actor can now send an authenticated POST request (using the X-PawPub-Actor header) to the listed endpoint with application/x-www-form-urlencoded form content, with verb set to one of the allowed verbs (or by default “poke” if not specified) and urgent either set or not set.1)

The allowed verbs are:

  • poke
  • bite
  • punch
  • kick
  • wave
  • yell
  • hug
  • kiss
  • pet

why these verbs specifically? are there any others we could add?

Example

POST /actor/132/poke HTTP/1.1
Host: antisocial.example
Authorization: Bearer ...
X-PawPub-Actor: https://social.example/actor/1
Content-Type: application/x-www-form-urlencoded
 
verb=yell&urgent=1

This would show the receiving actor a notification along the lines of “[user] yelled at you urgently” and possibly also indicate that the notification has urgent priority if the user's system allows.

1)
The exact value of urgent doesn't matter, but it would be sensible to set it to something like 1 or true. Receiving instances should not check its value, only whether it was present at all.
extension/poke.txt · Last modified: 2025/03/24 19:09 by winter