Get details for a specific webhook.
GET
/xrpc/place.stream.server.getWebhook
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” id
required
The ID of the webhook to retrieve.
string
The ID of the webhook to retrieve.
Responses
Section titled “ Responses ”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>
active
required
Whether this webhook is currently active.
boolean
prefix
Text to prepend to webhook messages.
string
suffix
Text to append to webhook messages.
string
rewrite
Text replacement rules for webhook messages.
Array<object>
object
from
required
Text to search for and replace.
string
to
required
Text to replace with.
string
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
description
A description of what this webhook is used for.
string
lastTriggered
When this webhook was last triggered.
string format: date-time
errorCount
Number of consecutive errors for this webhook.
integer
Bad Request