place.stream.server

Create a new webhook for receiving Streamplace events.

Changed on
post/xrpc/place.stream.server.createWebhook

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

urlstring uri required

The webhook URL where events will be sent.

eventsstring[] required

The types of events this webhook should receive.

activeboolean

Whether this webhook should be active upon creation.

prefixstring

Text to prepend to webhook messages.

suffixstring

Text to append to webhook messages.

namestring

A user-friendly name for this webhook.

descriptionstring

A description of what this webhook is used for.

muteWordsstring[]

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

Response

Success

Changes

  • 0eb3e511bec2Revision changes
    • warning

      added the new stream.received enum value to the // response property for the response status

    • info

      added the new stream.received enum value to the request property /

  • 3353f5f6354aRevision changes
    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      the / request property type changed from no type to object

    • breaking

      the response's property type changed from no type to object for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status