place.stream.server.defs

did:web:iame.li

Documentation

rewriteRule object

No description available.

Properties

from string Required

Text to search for and replace.

maxLength: 100 bytesminLength: 1 bytes
to string Required

Text to replace with.

maxLength: 100 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "maxLength": 100,
      "description": "Text to replace with."
    },
    "from": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Text to search for and replace."
    }
  }
}
webhook object

A webhook configuration for receiving Streamplace events.

Properties

active boolean Required

Whether this webhook is currently active.

createdAt string datetime Required

When this webhook was created.

description string Optional

A description of what this webhook is used for.

maxLength: 500 bytes
errorCount integer Optional

Number of consecutive errors for this webhook.

events array of string Required

The types of events this webhook should receive.

id string Required

Unique identifier for this webhook.

lastTriggered string datetime Optional

When this webhook was last triggered.

muteWords array of string Optional

Words to filter out from chat messages. Messages containing any of these words will not be forwarded.

name string Optional

A user-friendly name for this webhook.

maxLength: 100 bytes
prefix string Optional

Text to prepend to webhook messages.

maxLength: 100 bytes
rewrite array of ref#rewriteRule Optional

Text replacement rules for webhook messages.

suffix string Optional

Text to append to webhook messages.

maxLength: 100 bytes
updatedAt string datetime Optional

When this webhook was last updated.

url string uri Required

The webhook URL where events will be sent.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "url",
    "events",
    "active",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for this webhook."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The webhook URL where events will be sent."
    },
    "name": {
      "type": "string",
      "maxLength": 100,
      "description": "A user-friendly name for this webhook."
    },
    "active": {
      "type": "boolean",
      "description": "Whether this webhook is currently active."
    },
    "events": {
      "type": "array",
      "items": {
        "enum": [
          "chat",
          "livestream",
          "follow",
          "mention"
        ],
        "type": "string"
      },
      "description": "The types of events this webhook should receive."
    },
    "prefix": {
      "type": "string",
      "maxLength": 100,
      "description": "Text to prepend to webhook messages."
    },
    "suffix": {
      "type": "string",
      "maxLength": 100,
      "description": "Text to append to webhook messages."
    },
    "rewrite": {
      "type": "array",
      "items": {
        "ref": "#rewriteRule",
        "type": "ref"
      },
      "description": "Text replacement rules for webhook messages."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "When this webhook was created."
    },
    "muteWords": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100
      },
      "description": "Words to filter out from chat messages. Messages containing any of these words will not be forwarded."
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When this webhook was last updated."
    },
    "errorCount": {
      "type": "integer",
      "description": "Number of consecutive errors for this webhook."
    },
    "description": {
      "type": "string",
      "maxLength": 500,
      "description": "A description of what this webhook is used for."
    },
    "lastTriggered": {
      "type": "string",
      "format": "datetime",
      "description": "When this webhook was last triggered."
    }
  },
  "description": "A webhook configuration for receiving Streamplace events."
}

Lexicon Garden

@