List webhooks for the authenticated user.

GET

/xrpc/place.stream.server.listWebhooks

Parameters

Query Parameters

limit

The number of webhooks to return.

integer

default: 50 >= 1 <= 100

The number of webhooks to return.

cursor

An optional cursor for pagination.

string

An optional cursor for pagination.

active

Filter webhooks by active status.

boolean

Filter webhooks by active status.

event

Filter webhooks that handle this event type.

string

Allowed values: chat livestream follow mention

Filter webhooks that handle this event type.

Responses

200

Success

object

webhooks

required

Array<object>

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

cursor

A cursor for pagination, if there are more results.

string

400

Bad Request

object

error

required

One of:

string

string

message

required

string