# place.stream.server.listWebhooks

> List webhooks for the authenticated user.

- Kind: query
- Authority: server.stream.place
- Lexicon: 1
- Published by [stream.place](https://lexicon.garden/identity/did:plc:rbvrr34edl5ddpuwcubjiost), not the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:rbvrr34edl5ddpuwcubjiost/place.stream.server.listWebhooks)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:rbvrr34edl5ddpuwcubjiost/place.stream.server.listWebhooks/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:rbvrr34edl5ddpuwcubjiost/place.stream.server.listWebhooks/analytics)

## Query (`place.stream.server.listWebhooks`)

Type: query · GET

### Parameters (query string)

- `active` (boolean): Filter webhooks by active status.
- `cursor` (string): An optional cursor for pagination.
- `event` (string): Filter webhooks that handle this event type.
  - Constraints: enum: chat | livestream | follow | mention | stream.received
- `limit` (integer): The number of webhooks to return.
  - Constraints: minimum: 1, maximum: 100, default: 50

### Output (application/json)

- `cursor` (string): A cursor for pagination, if there are more results.
- `webhooks` (array, required)
  - `items` (ref)
    - Reference: `place.stream.server.defs#webhook`

### Errors

- `InvalidCursor`: The provided cursor is invalid or expired.

## Schema

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