place.stream.server.listWebhooks Documentation (EN)

main query

List webhooks for the authenticated user.

Parameters

active boolean Optional

Filter webhooks by active status.

cursor string Optional

An optional cursor for pagination.

event string Optional

Filter webhooks that handle this event type.

limit integer Optional

The number of webhooks to return.

Output

Encodingapplication/json

cursor string Optional

A cursor for pagination, if there are more results.

webhooks array Required

No description available.

Errors

InvalidCursor The provided cursor is invalid or expired.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

active Filter webhooks by active status.

cursor An optional cursor for pagination.

event Filter webhooks that handle this event type.

limit The number of webhooks to return.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "InvalidCursor",
      "description": "The provided cursor is invalid or expired."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "webhooks"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "description": "A cursor for pagination, if there are more results."
        },
        "webhooks": {
          "type": "array",
          "items": {
            "ref": "place.stream.server.defs#webhook",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "event": {
        "enum": [
          "chat",
          "livestream",
          "follow",
          "mention"
        ],
        "type": "string",
        "description": "Filter webhooks that handle this event type."
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "The number of webhooks to return."
      },
      "active": {
        "type": "boolean",
        "description": "Filter webhooks by active status."
      },
      "cursor": {
        "type": "string",
        "description": "An optional cursor for pagination."
      }
    }
  },
  "description": "List webhooks for the authenticated user."
}