Skip to content
Streamplace Logo Streamplace Docs

Update an existing webhook configuration.

POST
/xrpc/place.stream.server.updateWebhook

Request Body required

Section titled “Request Body required ”
object
id
required

The ID of the webhook to update.

string
url

The webhook URL where events will be sent.

string format: uri
events

The types of events this webhook should receive.

Array<string>
Allowed values: chat livestream follow mention
active

Whether this webhook should be active.

boolean
prefix

Text to prepend to webhook messages.

string
<= 100 characters
suffix

Text to append to webhook messages.

string
<= 100 characters
rewrite

Text replacement rules for webhook messages.

Array<object>
object
from
required

Text to search for and replace.

string
>= 1 characters <= 100 characters
to
required

Text to replace with.

string
<= 100 characters
name

A user-friendly name for this webhook.

string
<= 100 characters
description

A description of what this webhook is used for.

string
<= 500 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
webhook
required

A webhook configuration for receiving Streamplace events.

object
id
required

Unique identifier for this webhook.

string
url
required

The webhook URL where events will be sent.

string format: uri
events
required

The types of events this webhook should receive.

Array<string>
Allowed values: chat livestream follow mention
active
required

Whether this webhook is currently active.

boolean
prefix

Text to prepend to webhook messages.

string
<= 100 characters
suffix

Text to append to webhook messages.

string
<= 100 characters
rewrite

Text replacement rules for webhook messages.

Array<object>
object
from
required

Text to search for and replace.

string
>= 1 characters <= 100 characters
to
required

Text to replace with.

string
<= 100 characters
createdAt
required

When this webhook was created.

string format: date-time
updatedAt

When this webhook was last updated.

string format: date-time
name

A user-friendly name for this webhook.

string
<= 100 characters
description

A description of what this webhook is used for.

string
<= 500 characters
lastTriggered

When this webhook was last triggered.

string format: date-time
errorCount

Number of consecutive errors for this webhook.

integer

400

Section titled “400 ”

Bad Request

object
error
required
One of:
string
message
required
string