Skip to main content Link Search Menu Expand Document (external link)

["invite", "use"]

Table of contents

  1. Description
  2. Specification
    1. Requests
      1. Args
    2. Responses
  3. Support table
  4. Examples
    1. Requests
      1. go-ssb
      2. Patchwork
      3. Manyverse

Description

This request is related to redeeming pub invites.

The primary documentation for this request is the Scuttlebutt Protocol Guide.

Specification

Requests

Name
["invite", "use"]
Type
"async"
Args Must be an array containing exactly one object.

Args

The object within the args array must have the following schema:

Field name Required Type Description
feed
true
string

Id of the feed in the at-sign feed id format.

Responses

The response is a JSON object which describes the follow message which the pub published in its feed. The response must have the following schema:

Field name Required Type Description
key
true
string

Id of the message in the percent-sign message id format.

value
true
object

JSON object which is the raw message which the pub published to its feed.

Note: it is unclear what happens for feed formats other than the default feed format.

Notes:

Support table

Sends Accepts
go-ssb
v0.2.1
Unknown.
v0.2.1
Unknown.
Patchwork
3.18.1
Unknown.
3.18.1
Unknown.
Manyverse
v0.2203.21-beta
Unknown.
v0.2203.21-beta
Unknown.

Examples

Requests

go-ssb

Unknown.

Patchwork

Unknown.

Manyverse

Unknown.